Microsoft.DataBoxEdge (preview:2022-12-01)

2025/10/30 • 84 new, 84 deleted methods

Operations_List (new)
Description :  List all the supported operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataBoxEdge/operations
{
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Is data action. ,
Required: False ,
}
boolean ,
display:
{
Description: Properties displayed for the operation. ,
Required: False ,
}
{
provider:
{
Description: Provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The type of resource in which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation to be performed on the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation to be performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specification as defined by shoebox. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Description of the metric to be displayed. ,
Required: False ,
}
string ,
unit:
{
Description: Metric units. ,
Enum:
{
NotSpecified: No description available. ,
Percent: No description available. ,
Count: No description available. ,
Seconds: No description available. ,
Milliseconds: No description available. ,
Bytes: No description available. ,
BytesPerSecond: No description available. ,
CountPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
aggregationType:
{
Description: Metric aggregation type. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
Average: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Total: No description available. ,
Count: No description available. ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: Metric dimensions, other than default dimension which is resource. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metrics dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the metrics dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: To be exported to shoe box. ,
Required: False ,
}
boolean ,
}
,
]
,
fillGapWithZero:
{
Description: Set true to fill the gaps with zero. ,
Required: False ,
}
boolean ,
category:
{
Description: Metric category. ,
Enum:
{
Capacity: No description available. ,
Transaction: No description available. ,
}
,
Required: False ,
}
enum ,
resourceIdDimensionNameOverride:
{
Description: Resource name override. ,
Required: False ,
}
string ,
supportedTimeGrainTypes:
{
Description: Support granularity of metrics. ,
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Description: Support metric aggregation type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AvailableSkus_List (new)
Description :  List all the available Skus and information related to them.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ResourceType Sku ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The Sku name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The Sku kind. ,
Required: False ,
}
string ,
tier:
{
Description: The Sku tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The Sku kind. ,
Required: False ,
}
string ,
family:
{
Description: The Sku family. ,
Required: False ,
}
string ,
locations:
{
Description: Availability of the Sku for the region. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: The API versions in which Sku is available. ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Availability of the Sku for the location/zone/site. ,
Required: False ,
}
[
{
location:
{
Description: The location. ,
Required: False ,
}
string ,
zones:
{
Description: The zones. ,
Required: False ,
}
[
string ,
]
,
sites:
{
Description: The sites. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
costs:
{
Description: The pricing info of the Sku. ,
Required: False ,
}
[
{
meterId:
{
Description: Used for querying price from commerce. ,
Required: False ,
}
string ,
quantity:
{
Description: The cost quantity. ,
Format: int64 ,
Required: False ,
}
integer ,
extendedUnit:
{
Description: The extended unit. ,
Required: False ,
}
string ,
}
,
]
,
signupOption:
{
Description: Sku can be signed up by customer or not. ,
Enum:
{
None: No description available. ,
Available: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Availability of the Sku as preview/stable. ,
Enum:
{
Stable: No description available. ,
Preview: No description available. ,
}
,
Required: False ,
}
enum ,
availability:
{
Description: Links to the next set of results ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
shipmentTypes:
{
Description: List of Shipment Types supported by this SKU ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The capability info of the SKU. ,
Required: False ,
}
[
{
name:
{
Description: An invariant to describe the feature. ,
Required: False ,
}
string ,
value:
{
Description: An invariant if the feature is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Links to the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_ListBySubscription (new)
Description :  Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Data Box Edge/Gateway devices. ,
Required: False ,
}
[
{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_ListByResourceGroup (new)
Description :  Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Data Box Edge/Gateway devices. ,
Required: False ,
}
[
{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_Get (new)
Description :  Gets the properties of the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_CreateOrUpdate (new)
Description :  Creates or updates a Data Box Edge/Data Box Gateway resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
dataBoxEdgeDevice:
{
Description: The resource object. ,
Required: True ,
}
{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_Delete (new)
Description :  Deletes the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_Update (new)
Description :  Modifies a Data Box Edge/Data Box Gateway resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags attached to the Data Box Edge/Gateway resource. ,
Required: False ,
}
object ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated with the Data Box Edge/Gateway resource ,
Required: False ,
}
{
edgeProfile:
{
Description: Edge Profile property of the Data Box Edge/Gateway device ,
Required: False ,
}
{
subscription:
{
Description: The Data Box Edge/Gateway Edge Profile Subscription patch ,
Required: False ,
}
{
id:
{
Description: The path ID that uniquely identifies the subscription of the edge profile. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Alerts_ListByDataBoxEdgeDevice (new)
Description :  Gets all the alerts for a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of alert. ,
Required: False ,
}
{
title:
{
Description: Alert title. ,
Required: False ,
}
string ,
alertType:
{
Description: Alert type. ,
Required: False ,
}
string ,
appearedAtDateTime:
{
Description: UTC time when the alert appeared. ,
Format: date-time ,
Required: False ,
}
string ,
recommendation:
{
Description: Alert recommendation. ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the alert. ,
Enum:
{
Informational: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details of the alert. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message. ,
Required: False ,
}
string ,
occurrences:
{
Description: Number of occurrences. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
detailedInformation:
{
Description: Alert details. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Alert ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Alerts_Get (new)
Description :  Gets an alert by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The alert name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of alert. ,
Required: False ,
}
{
title:
{
Description: Alert title. ,
Required: False ,
}
string ,
alertType:
{
Description: Alert type. ,
Required: False ,
}
string ,
appearedAtDateTime:
{
Description: UTC time when the alert appeared. ,
Format: date-time ,
Required: False ,
}
string ,
recommendation:
{
Description: Alert recommendation. ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the alert. ,
Enum:
{
Informational: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details of the alert. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message. ,
Required: False ,
}
string ,
occurrences:
{
Description: Number of occurrences. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
detailedInformation:
{
Description: Alert details. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Alert ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_ListByDataBoxEdgeDevice (new)
Description :  Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of bandwidth schedules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_Get (new)
Description :  Gets the properties of the specified bandwidth schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The bandwidth schedule name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_CreateOrUpdate (new)
Description :  Creates or updates a bandwidth schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The bandwidth schedule name which needs to be added/updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The bandwidth schedule to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_Delete (new)
Description :  Deletes the specified bandwidth schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The bandwidth schedule name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeviceCapacityCheck_CheckResourceCreationFeasibility (new)
Description :  Posts the device capacity request info to check feasibility.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityCheck
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
deviceCapacityRequestInfo:
{
Description: The device capacity request info. ,
Required: True ,
}
{
properties:
{
Description: The properties of the Device Capacity Request. ,
Required: True ,
}
{
vmPlacementQuery:
{
Description: Array containing the sizes of the VMs for checking if its feasible to create them on the appliance. ,
Required: True ,
}
[
string ,
]
,
vmPlacementResults:
{
Description: Array of the VMs of the sizes in VmSizes can be provisioned on the appliance. ,
Required: False ,
}
[
{
vmSize:
{
Description: List of VM sizes being checked. ,
Required: False ,
}
[
string ,
]
,
isFeasible:
{
Description: Boolean value indicating if the VM(s) in VmSize can be created. ,
Required: False ,
}
boolean ,
messageCode:
{
Description: MessageCode indicating reason for success or failure. ,
Required: False ,
}
string ,
message:
{
Description: Localized message to be displayed to the user to explain the check result. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
capacityName:
{
Description: The capacity name. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeviceCapacityInfo_GetDeviceCapacityInfo (new)
Description :  Gets the properties of the specified device capacity info.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The device capacity properties. ,
Required: False ,
}
{
timeStamp:
{
Description: Timestamp of request in UTC ,
Format: date-time ,
Required: False ,
}
string ,
clusterStorageCapacityInfo:
{
Description: Cluster capacity data for storage resources (CSV). ,
Required: False ,
}
{
clusterTotalStorageMb:
{
Description: Total storage on the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterFreeStorageMb:
{
Description: The available or free storage on the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
}
,
clusterComputeCapacityInfo:
{
Description: Cluster capacity data for compute resources (Memory and GPU). ,
Required: False ,
}
{
fqdn:
{
Description: The FQDN of the cluster. ,
Required: False ,
}
string ,
gpuCapacity:
{
Description: The cluster's GPU capacity. ,
Required: False ,
}
{
gpuType:
{
Description: The cluster GPU Type. ,
Required: False ,
}
string ,
gpuUsedUnitsCount:
{
Description: The used GPU units count in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
gpuFreeUnitsCount:
{
Description: The free GPU units count in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
gpuReservedForFailoverUnitsCount:
{
Description: The GPU units count reserved for failover in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
gpuTotalUnitsCount:
{
Description: The total GPU units count in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryCapacity:
{
Description: The cluster's memory capacity. ,
Required: False ,
}
{
clusterFreeMemoryMb:
{
Description: The free memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterUsedMemoryMb:
{
Description: The used memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterFailoverMemoryMb:
{
Description: The failover memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterFragmentationMemoryMb:
{
Description: The fragmentation memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterHypervReserveMemoryMb:
{
Description: The memory reserved for Hyper-V in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterInfraVmMemoryMb:
{
Description: The memory of the Infra VM in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterTotalMemoryMb:
{
Description: The total memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterNonFailoverVmMb:
{
Description: The non-failover memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterMemoryUsedByVmsMb:
{
Description: The memory used by VMs in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
}
,
lastRefreshedTime:
{
Description: The last time at which the ClusterCapacityViewData was set. ,
Format: date-time ,
Required: False ,
}
string ,
totalProvisionedNonHpnCores:
{
Description: The total # of vCPUs provisioned by non-HPN VM per appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
nodeCapacityInfos:
{
Description: The dictionary of individual node names and node capacities in the cluster. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to device capacity info. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_GetDiagnosticProactiveLogCollectionSettings (new)
Description :  Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the diagnostic proactive log collection settings. ,
Required: True ,
}
{
userConsent:
{
Description: Proactive diagnostic collection consent flag ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings (new)
Description :  Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
proactiveLogCollectionSettings:
{
Description: The proactive log collection settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the diagnostic proactive log collection settings. ,
Required: True ,
}
{
userConsent:
{
Description: Proactive diagnostic collection consent flag ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the diagnostic proactive log collection settings. ,
Required: True ,
}
{
userConsent:
{
Description: Proactive diagnostic collection consent flag ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_GetDiagnosticRemoteSupportSettings (new)
Description :  Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the remote support settings. ,
Required: True ,
}
{
remoteSupportSettingsList:
{
Description: Remote support settings list according to the RemoteApplicationType ,
Required: False ,
}
[
{
remoteApplicationType:
{
Description: Remote application type ,
Enum:
{
Powershell: No description available. ,
WAC: No description available. ,
LocalUI: No description available. ,
AllApplications: No description available. ,
}
,
Required: False ,
}
enum ,
accessLevel:
{
Description: Access level allowed for this remote application type ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
FullAccess: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeStampInUTC:
{
Description: Expiration time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Represents resource creation and updation time ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings (new)
Description :  Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
diagnosticRemoteSupportSettings:
{
Description: The diagnostic remote support settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the remote support settings. ,
Required: True ,
}
{
remoteSupportSettingsList:
{
Description: Remote support settings list according to the RemoteApplicationType ,
Required: False ,
}
[
{
remoteApplicationType:
{
Description: Remote application type ,
Enum:
{
Powershell: No description available. ,
WAC: No description available. ,
LocalUI: No description available. ,
AllApplications: No description available. ,
}
,
Required: False ,
}
enum ,
accessLevel:
{
Description: Access level allowed for this remote application type ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
FullAccess: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeStampInUTC:
{
Description: Expiration time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Represents resource creation and updation time ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: Properties of the remote support settings. ,
Required: True ,
}
{
remoteSupportSettingsList:
{
Description: Remote support settings list according to the RemoteApplicationType ,
Required: False ,
}
[
{
remoteApplicationType:
{
Description: Remote application type ,
Enum:
{
Powershell: No description available. ,
WAC: No description available. ,
LocalUI: No description available. ,
AllApplications: No description available. ,
}
,
Required: False ,
}
enum ,
accessLevel:
{
Description: Access level allowed for this remote application type ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
FullAccess: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeStampInUTC:
{
Description: Expiration time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Represents resource creation and updation time ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_DownloadUpdates (new)
Description :  Downloads the updates on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GenerateCertificate (new)
Description :  Generates certificate for activation key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
publicKey:
{
Description: Gets or sets base64 encoded certificate raw data, this is the public part needed to be uploaded to cert vault ,
Required: False ,
}
string ,
privateKey:
{
Description: Gets or sets base64 encoded private part of the certificate, needed to form the activation key ,
Required: False ,
}
string ,
expiryTimeInUTC:
{
Description: Gets or sets expiry time in UTC ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GetExtendedInformation (new)
Description :  Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
encryptionKeyThumbprint:
{
Description: The digital signature of encrypted certificate. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: The public part of the encryption certificate. Client uses this to encrypt any secret. ,
Required: False ,
}
string ,
resourceKey:
{
Description: The Resource ID of the Resource. ,
Required: False ,
}
string ,
clientSecretStoreId:
{
Description: The Key Vault ARM Id for client secrets ,
Required: False ,
}
string ,
clientSecretStoreUrl:
{
Description: The url to access the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyName:
{
Description: The name of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyVersion:
{
Description: The version of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
keyVaultSyncStatus:
{
Description: Key vault sync status ,
Enum:
{
KeyVaultSynced: No description available. ,
KeyVaultSyncFailed: No description available. ,
KeyVaultNotConfigured: No description available. ,
KeyVaultSyncPending: No description available. ,
KeyVaultSyncing: No description available. ,
KeyVaultNotSynced: No description available. ,
}
,
Required: False ,
}
enum ,
deviceSecrets:
{
Description: Device secrets, will be returned only with ODataFilter $expand=deviceSecrets ,
Required: False ,
}
object ,
clusterWitnessType:
{
Description: Cluster Witness Type ,
Enum:
{
None: No description available. ,
Cloud: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
fileShareWitnessLocation:
{
Description: The witness location of file share. ,
Required: False ,
}
string ,
fileShareWitnessUsername:
{
Description: The username of file share. ,
Required: False ,
}
string ,
cloudWitnessStorageAccountName:
{
Description: The Cloud Witness Storage account name. ,
Required: False ,
}
string ,
cloudWitnessContainerName:
{
Description: The Container for cloud witness in the storage account. ,
Required: False ,
}
string ,
cloudWitnessStorageEndpoint:
{
Description: The Azure service endpoint of the cloud witness storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DataBoxEdgeDevice ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_InstallUpdates (new)
Description :  Installs the updates on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_Get (new)
Description :  Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The job name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The path ID that uniquely identifies the object. ,
Required: False ,
}
string ,
name:
{
Description: The name of the object. ,
Required: False ,
}
string ,
type:
{
Description: The hierarchical type of the object. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is complete. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: The error details. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
Invalid: No description available. ,
ScanForUpdates: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
RefreshShare: No description available. ,
RefreshContainer: No description available. ,
Backup: No description available. ,
Restore: No description available. ,
TriggerSupportPackage: No description available. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current stage of the update operation. ,
Enum:
{
Unknown: No description available. ,
Initial: No description available. ,
ScanStarted: No description available. ,
ScanComplete: No description available. ,
ScanFailed: No description available. ,
DownloadStarted: No description available. ,
DownloadComplete: No description available. ,
DownloadFailed: No description available. ,
InstallStarted: No description available. ,
InstallComplete: No description available. ,
InstallFailed: No description available. ,
RebootInitiated: No description available. ,
Success: No description available. ,
Failure: No description available. ,
RescanStarted: No description available. ,
RescanComplete: No description available. ,
RescanFailed: No description available. ,
}
,
Required: False ,
}
enum ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage completed. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
totalRefreshErrors:
{
Description: Total number of errors encountered during the refresh process. ,
Format: int32 ,
Required: False ,
}
integer ,
errorManifestFile:
{
Description: Local share/remote container relative path to the error manifest file of the refresh. ,
Required: False ,
}
string ,
refreshedEntityId:
{
Description: ARM ID of the entity that was refreshed. ,
Required: False ,
}
string ,
folder:
{
Description: If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GetNetworkSettings (new)
Description :  Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of network settings of a device. ,
Required: False ,
}
{
networkAdapters:
{
Description: The network adapter list on the device. ,
Required: False ,
}
[
{
adapterId:
{
Description: Instance ID of network adapter. ,
Required: False ,
}
string ,
adapterPosition:
{
Description: Hardware position of network adapter. ,
Required: False ,
}
{
networkGroup:
{
Description: The network group. ,
Enum:
{
None: No description available. ,
NonRDMA: No description available. ,
RDMA: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
index:
{
Description: Logical index of the adapter. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeId:
{
Description: Node ID of the network adapter. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Network adapter name. ,
Required: False ,
}
string ,
label:
{
Description: Hardware label for the adapter. ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address. ,
Required: False ,
}
string ,
linkSpeed:
{
Description: Link speed. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Value indicating whether this adapter is valid. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
rdmaStatus:
{
Description: Value indicating whether this adapter is RDMA capable. ,
Enum:
{
Incapable: No description available. ,
Capable: No description available. ,
}
,
Required: False ,
}
enum ,
dhcpStatus:
{
Description: Value indicating whether this adapter has DHCP enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4Configuration:
{
Description: The IPv4 configuration of the network adapter. ,
Required: False ,
}
{
ipAddress:
{
Description: The IPv4 address of the network adapter. ,
Required: False ,
}
string ,
subnet:
{
Description: The IPv4 subnet of the network adapter. ,
Required: False ,
}
string ,
gateway:
{
Description: The IPv4 gateway of the network adapter. ,
Required: False ,
}
string ,
}
,
ipv6Configuration:
{
Description: The IPv6 configuration of the network adapter. ,
Required: False ,
}
{
ipAddress:
{
Description: The IPv6 address of the network adapter. ,
Required: False ,
}
string ,
prefixLength:
{
Description: The IPv6 prefix of the network adapter. ,
Format: int32 ,
Required: False ,
}
integer ,
gateway:
{
Description: The IPv6 gateway of the network adapter. ,
Required: False ,
}
string ,
}
,
ipv6LinkLocalAddress:
{
Description: The IPv6 local address. ,
Required: False ,
}
string ,
dnsServers:
{
Description: The list of DNS Servers of the device. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of NetworkSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Nodes_ListByDataBoxEdgeDevice (new)
Description :  Gets all the nodes currently configured under this Data Box Edge device
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Nodes. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the node ,
Required: False ,
}
{
nodeStatus:
{
Description: The current status of the individual node ,
Enum:
{
Unknown: No description available. ,
Up: No description available. ,
Down: No description available. ,
Rebooting: No description available. ,
ShuttingDown: No description available. ,
}
,
Required: False ,
}
enum ,
nodeChassisSerialNumber:
{
Description: Serial number of the Chassis ,
Required: False ,
}
string ,
nodeSerialNumber:
{
Description: Serial number of the individual node ,
Required: False ,
}
string ,
nodeDisplayName:
{
Description: Display Name of the individual node ,
Required: False ,
}
string ,
nodeFriendlySoftwareVersion:
{
Description: Friendly software version name that is currently installed on the node ,
Required: False ,
}
string ,
nodeHcsVersion:
{
Description: HCS version that is currently installed on the node ,
Required: False ,
}
string ,
nodeInstanceId:
{
Description: Guid instance id of the node ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageOffer_ListOffers (new)
Description :  Returns list of all offers
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/offers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
skuMappings:
{
Required: False ,
}
[
{
catalogPlanId:
{
Required: False ,
}
string ,
marketplaceSkuId:
{
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OperationsStatus_Get (new)
Description :  Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The job name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The path ID that uniquely identifies the object. ,
Required: False ,
}
string ,
name:
{
Description: The name of the object. ,
Required: False ,
}
string ,
type:
{
Description: The hierarchical type of the object. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is complete. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: The error details. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
Invalid: No description available. ,
ScanForUpdates: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
RefreshShare: No description available. ,
RefreshContainer: No description available. ,
Backup: No description available. ,
Restore: No description available. ,
TriggerSupportPackage: No description available. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current stage of the update operation. ,
Enum:
{
Unknown: No description available. ,
Initial: No description available. ,
ScanStarted: No description available. ,
ScanComplete: No description available. ,
ScanFailed: No description available. ,
DownloadStarted: No description available. ,
DownloadComplete: No description available. ,
DownloadFailed: No description available. ,
InstallStarted: No description available. ,
InstallComplete: No description available. ,
InstallFailed: No description available. ,
RebootInitiated: No description available. ,
Success: No description available. ,
Failure: No description available. ,
RescanStarted: No description available. ,
RescanComplete: No description available. ,
RescanFailed: No description available. ,
}
,
Required: False ,
}
enum ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage completed. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
totalRefreshErrors:
{
Description: Total number of errors encountered during the refresh process. ,
Format: int32 ,
Required: False ,
}
integer ,
errorManifestFile:
{
Description: Local share/remote container relative path to the error manifest file of the refresh. ,
Required: False ,
}
string ,
refreshedEntityId:
{
Description: ARM ID of the entity that was refreshed. ,
Required: False ,
}
string ,
folder:
{
Description: If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_ListByDataBoxEdgeDevice (new)
Description :  Lists all the orders related to a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of orders. ,
Required: False ,
}
[
{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_Get (new)
Description :  Gets a specific order by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_CreateOrUpdate (new)
Description :  Creates or updates an order.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default
{
deviceName:
{
Description: The order details of a device. ,
Required: True ,
}
string ,
order:
{
Description: The order to be created or updated. ,
Required: True ,
}
{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_Delete (new)
Description :  Deletes the order related to the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_ListDCAccessCode (new)
Description :  Gets the DCAccess Code
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DCAccessCode properties. ,
Required: False ,
}
{
authCode:
{
Description: DCAccess Code for the Self Managed shipment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImagePublisher_ListPublishers (new)
Description :  Returns list of publishers
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageOffer_ListOffersbyPublisher (new)
Description :  Returns List of Offers by Publisher name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
skuMappings:
{
Required: False ,
}
[
{
catalogPlanId:
{
Required: False ,
}
string ,
marketplaceSkuId:
{
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageSku_ListSKUsWithinOffer (new)
Description :  Returns List of SKUs Within Offer
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
offerId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
skuMappings:
{
Required: False ,
}
[
{
catalogPlanId:
{
Required: False ,
}
string ,
marketplaceSkuId:
{
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageVersion_ListVersionswithinSKU (new)
Description :  Returns List of Versions within SKU
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
skuName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
offerId:
{
Required: False ,
}
string ,
skuId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageVersion_GetParticularImage (new)
Description :  Get Particular Image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
skuName:
{
Required: True ,
}
string ,
versionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
offerId:
{
Required: False ,
}
string ,
skuId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageSasToken_GetSASToken (new)
Description :  Returns SASToken
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}/generatesastoken
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
skuName:
{
Required: True ,
}
string ,
versionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
status:
{
Required: False ,
}
string ,
sasUri:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Required: False ,
}
string ,
sasUri:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_ListByDataBoxEdgeDevice (new)
Description :  Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Value. ,
Required: False ,
}
[
{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Get (new)
Description :  Gets a specific role by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_CreateOrUpdate (new)
Description :  Create or update a role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The role name. ,
Required: True ,
}
string ,
role:
{
Description: The role properties. ,
Required: True ,
}
{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Delete (new)
Description :  Deletes the role on the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_ListByRole (new)
Description :  Lists all the addons configured in the role.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Value. ,
Required: False ,
}
[
{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_Get (new)
Description :  Gets a specific addon by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
addonName:
{
Description: The addon name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_CreateOrUpdate (new)
Description :  Create or update a addon.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
addonName:
{
Description: The addon name. ,
Required: True ,
}
string ,
addon:
{
Description: The addon properties. ,
Required: True ,
}
{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_Delete (new)
Description :  Deletes the addon on the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
addonName:
{
Description: The addon name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_List (new)
Description :  Lists metric configurations in a role.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_Get (new)
Description :  Gets a metric configuration of a role.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_CreateOrUpdate (new)
Description :  Creates a new metric configuration or updates an existing one for a role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
monitoringMetricConfiguration:
{
Description: The metric configuration. ,
Required: True ,
}
{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_Delete (new)
Description :  deletes a new metric configuration for a role.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_ScanForUpdates (new)
Description :  Scans for updates on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_CreateOrUpdateSecuritySettings (new)
Description :  Updates the security settings on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the security settings. ,
Required: True ,
}
{
deviceAdminPassword:
{
Description: Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters. ,
Required: True ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_ListByDataBoxEdgeDevice (new)
Description :  Lists all the shares in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shares. ,
Required: False ,
}
[
{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_Get (new)
Description :  Gets a share by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_CreateOrUpdate (new)
Description :  Creates a new share or updates an existing share on the device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
share:
{
Description: The share properties. ,
Required: True ,
}
{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_Delete (new)
Description :  Deletes the share on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_Refresh (new)
Description :  Refreshes the share metadata with the data from the cloud.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_ListByDataBoxEdgeDevice (new)
Description :  Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_Get (new)
Description :  Gets the properties of the specified storage account credential.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_CreateOrUpdate (new)
Description :  Creates or updates the storage account credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
storageAccountCredential:
{
Description: The storage account credential. ,
Required: True ,
}
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_Delete (new)
Description :  Deletes the storage account credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_ListByDataBoxEdgeDevice (new)
Description :  Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of storageAccounts. ,
Required: False ,
}
[
{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_Get (new)
Description :  Gets a StorageAccount by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_CreateOrUpdate (new)
Description :  Creates a new StorageAccount or updates an existing StorageAccount on the device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The StorageAccount name. ,
Required: True ,
}
string ,
storageAccount:
{
Description: The StorageAccount properties. ,
Required: True ,
}
{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_Delete (new)
Description :  Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The StorageAccount name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_ListByStorageAccount (new)
Description :  Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The storage Account name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of containers. ,
Required: False ,
}
[
{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Get (new)
Description :  Gets a container by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_CreateOrUpdate (new)
Description :  Creates a new container or updates an existing container on the device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
container:
{
Description: The container properties. ,
Required: True ,
}
{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Delete (new)
Description :  Deletes the container on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Refresh (new)
Description :  Refreshes the container metadata with the data from the cloud.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_ListByDataBoxEdgeDevice (new)
Description :  Lists all the triggers configured in the device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$filter:
{
Description: Specify $filter='CustomContextTag eq ' to filter on custom context tag property ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of triggers. ,
Required: False ,
}
[
{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_Get (new)
Description :  Get a specific trigger by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The trigger name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_CreateOrUpdate (new)
Description :  Creates or updates a trigger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
{
deviceName:
{
Description: Creates or updates a trigger ,
Required: True ,
}
string ,
name:
{
Description: The trigger name. ,
Required: True ,
}
string ,
trigger:
{
Description: The trigger. ,
Required: True ,
}
{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_Delete (new)
Description :  Deletes the trigger on the gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The trigger name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SupportPackages_TriggerSupportPackage (new)
Description :  Triggers support package on the device
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
triggerSupportPackageRequest:
{
Description: The trigger support package request object ,
Required: True ,
}
{
properties:
{
Description: The TriggerSupportPackageRequest properties. ,
Required: True ,
}
{
minimumTimeStamp:
{
Description: MinimumTimeStamp from where logs need to be collected ,
Format: date-time ,
Required: False ,
}
string ,
maximumTimeStamp:
{
Description: Start of the timespan of the log collection ,
Format: date-time ,
Required: False ,
}
string ,
include:
{
Description: Type of files, which need to be included in the logs This will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived) or a comma separated list of log types that are required ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_UpdateExtendedInformation (new)
Description :  Gets additional information for the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
parameters:
{
Description: The patch object. ,
Required: True ,
}
{
clientSecretStoreId:
{
Description: The Key Vault ARM Id for client secrets ,
Required: False ,
}
string ,
clientSecretStoreUrl:
{
Description: The url to access the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyName:
{
Description: The name for Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyVersion:
{
Description: The version of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
syncStatus:
{
Description: For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable. ,
Enum:
{
KeyVaultSynced: No description available. ,
KeyVaultSyncFailed: No description available. ,
KeyVaultNotConfigured: No description available. ,
KeyVaultSyncPending: No description available. ,
KeyVaultSyncing: No description available. ,
KeyVaultNotSynced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
encryptionKeyThumbprint:
{
Description: The digital signature of encrypted certificate. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: The public part of the encryption certificate. Client uses this to encrypt any secret. ,
Required: False ,
}
string ,
resourceKey:
{
Description: The Resource ID of the Resource. ,
Required: False ,
}
string ,
clientSecretStoreId:
{
Description: The Key Vault ARM Id for client secrets ,
Required: False ,
}
string ,
clientSecretStoreUrl:
{
Description: The url to access the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyName:
{
Description: The name of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyVersion:
{
Description: The version of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
keyVaultSyncStatus:
{
Description: Key vault sync status ,
Enum:
{
KeyVaultSynced: No description available. ,
KeyVaultSyncFailed: No description available. ,
KeyVaultNotConfigured: No description available. ,
KeyVaultSyncPending: No description available. ,
KeyVaultSyncing: No description available. ,
KeyVaultNotSynced: No description available. ,
}
,
Required: False ,
}
enum ,
deviceSecrets:
{
Description: Device secrets, will be returned only with ODataFilter $expand=deviceSecrets ,
Required: False ,
}
object ,
clusterWitnessType:
{
Description: Cluster Witness Type ,
Enum:
{
None: No description available. ,
Cloud: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
fileShareWitnessLocation:
{
Description: The witness location of file share. ,
Required: False ,
}
string ,
fileShareWitnessUsername:
{
Description: The username of file share. ,
Required: False ,
}
string ,
cloudWitnessStorageAccountName:
{
Description: The Cloud Witness Storage account name. ,
Required: False ,
}
string ,
cloudWitnessContainerName:
{
Description: The Container for cloud witness in the storage account. ,
Required: False ,
}
string ,
cloudWitnessStorageEndpoint:
{
Description: The Azure service endpoint of the cloud witness storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DataBoxEdgeDevice ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GetUpdateSummary (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The device update information summary. ,
Required: False ,
}
{
deviceVersionNumber:
{
Description: The current version of the device in format: 1.2.17312.13.", ,
Required: False ,
}
string ,
friendlyDeviceVersionName:
{
Description: The current version of the device in text format. ,
Required: False ,
}
string ,
deviceLastScannedDateTime:
{
Description: The last time when a scan was done on the device. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedScanJobDateTime:
{
Description: The time when the last scan job was completed (success/cancelled/failed) on the appliance. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulScanJobTime:
{
Description: Time when the last scan job is successfully completed. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedDownloadJobDateTime:
{
Description: The time when the last Download job was completed (success/cancelled/failed) on the appliance. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedDownloadJobId:
{
Description: JobId of the last ran download job.(Can be success/cancelled/failed) ,
Required: False ,
}
string ,
lastDownloadJobStatus:
{
Description: JobStatus of the last ran download job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSuccessfulInstallJobDateTime:
{
Description: The time when the Last Install job was completed successfully on the appliance ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedInstallJobDateTime:
{
Description: The time when the last Install job was completed (success/cancelled/failed) on the appliance. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedInstallJobId:
{
Description: JobId of the last ran install job.(Can be success/cancelled/failed) ,
Required: False ,
}
string ,
lastInstallJobStatus:
{
Description: JobStatus of the last ran install job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
totalNumberOfUpdatesAvailable:
{
Description: The number of updates available for the current device version as per the last device scan. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfUpdatesPendingDownload:
{
Description: The total number of items pending download. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfUpdatesPendingInstall:
{
Description: The total number of items pending install. ,
Format: int32 ,
Required: False ,
}
integer ,
rebootBehavior:
{
Description: Indicates if updates are available and at least one of the updates needs a reboot. ,
Enum:
{
NeverReboots: No description available. ,
RequiresReboot: No description available. ,
RequestReboot: No description available. ,
}
,
Required: False ,
}
enum ,
ongoingUpdateOperation:
{
Description: The current update operation. ,
Enum:
{
None: No description available. ,
Scan: No description available. ,
Download: No description available. ,
Install: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressDownloadJobId:
{
Description: The job ID of the download job in progress. ,
Required: False ,
}
string ,
inProgressInstallJobId:
{
Description: The job ID of the install job in progress. ,
Required: False ,
}
string ,
inProgressDownloadJobStartedDateTime:
{
Description: The time when the currently running download (if any) started. ,
Format: date-time ,
Required: False ,
}
string ,
inProgressInstallJobStartedDateTime:
{
Description: The time when the currently running install (if any) started. ,
Format: date-time ,
Required: False ,
}
string ,
updateTitles:
{
Description: The list of updates available for install. ,
Required: False ,
}
[
string ,
]
,
updates:
{
Description: The list of updates available for install. ,
Required: False ,
}
[
{
updateTitle:
{
Description: Title of the Update ,
Required: False ,
}
string ,
updateSize:
{
Description: Size of the update(In Bytes) ,
Format: double ,
Required: False ,
}
number ,
updateType:
{
Description: Type of the Update ,
Enum:
{
Software: No description available. ,
Kubernetes: No description available. ,
Firmware: No description available. ,
}
,
Required: False ,
}
enum ,
targetVersion:
{
Description: Target Version number ,
Required: False ,
}
string ,
friendlyVersionNumber:
{
Description: Friendly Version Number ,
Required: False ,
}
string ,
estimatedInstallTimeInMins:
{
Description: Estimated Install Time for the update ,
Format: int32 ,
Required: False ,
}
integer ,
rebootBehavior:
{
Description: Indicates if updates are available and at least one of the updates needs a reboot. ,
Enum:
{
NeverReboots: No description available. ,
RequiresReboot: No description available. ,
RequestReboot: No description available. ,
}
,
Required: False ,
}
enum ,
installationImpact:
{
Description: Impact of Installing an updateType ,
Enum:
{
None: No description available. ,
DeviceRebooted: No description available. ,
KubernetesWorkloadsDown: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the update. ,
Enum:
{
DownloadPending: No description available. ,
DownloadStarted: No description available. ,
DownloadCompleted: No description available. ,
InstallStarted: No description available. ,
InstallCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
totalUpdateSizeInBytes:
{
Description: The total size of updates available for download in bytes. ,
Format: double ,
Required: False ,
}
number ,
totalTimeInMinutes:
{
Description: The total time in Minutes ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of UpdateSummary ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_UploadCertificate (new)
Description :  Uploads registration certificate for the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
parameters:
{
Description: The upload certificate request. ,
Required: True ,
}
{
properties:
{
Description: The Base 64 encoded certificate raw data. ,
Required: True ,
}
{
authenticationType:
{
Description: The authentication type. ,
Enum:
{
Invalid: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The base64 encoded certificate raw data. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authType:
{
Description: Specifies authentication type. ,
Enum:
{
Invalid: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resource ID of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Azure Active Directory tenant authority. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Azure Active Directory tenant ID. ,
Required: False ,
}
string ,
servicePrincipalClientId:
{
Description: Azure Active Directory service principal client ID. ,
Required: False ,
}
string ,
servicePrincipalObjectId:
{
Description: Azure Active Directory service principal object ID. ,
Required: False ,
}
string ,
azureManagementEndpointAudience:
{
Description: The azure management endpoint audience. ,
Required: False ,
}
string ,
aadAudience:
{
Description: Identifier of the target resource that is the recipient of the requested token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_ListByDataBoxEdgeDevice (new)
Description :  Gets all the users registered on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$filter:
{
Description: Specify $filter='Type eq ' to filter on user type property ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of users. ,
Required: False ,
}
[
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Get (new)
Description :  Gets the properties of the specified user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The user name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_CreateOrUpdate (new)
Description :  Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The user name. ,
Required: True ,
}
string ,
user:
{
Description: The user details. ,
Required: True ,
}
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Delete (new)
Description :  Deletes the user on a databox edge/gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The user name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  List all the supported operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataBoxEdge/operations
{
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Is data action. ,
Required: False ,
}
boolean ,
display:
{
Description: Properties displayed for the operation. ,
Required: False ,
}
{
provider:
{
Description: Provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The type of resource in which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation to be performed on the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation to be performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specification as defined by shoebox. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Description of the metric to be displayed. ,
Required: False ,
}
string ,
unit:
{
Description: Metric units. ,
Enum:
{
NotSpecified: No description available. ,
Percent: No description available. ,
Count: No description available. ,
Seconds: No description available. ,
Milliseconds: No description available. ,
Bytes: No description available. ,
BytesPerSecond: No description available. ,
CountPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
aggregationType:
{
Description: Metric aggregation type. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
Average: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Total: No description available. ,
Count: No description available. ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: Metric dimensions, other than default dimension which is resource. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metrics dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the metrics dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: To be exported to shoe box. ,
Required: False ,
}
boolean ,
}
,
]
,
fillGapWithZero:
{
Description: Set true to fill the gaps with zero. ,
Required: False ,
}
boolean ,
category:
{
Description: Metric category. ,
Enum:
{
Capacity: No description available. ,
Transaction: No description available. ,
}
,
Required: False ,
}
enum ,
resourceIdDimensionNameOverride:
{
Description: Resource name override. ,
Required: False ,
}
string ,
supportedTimeGrainTypes:
{
Description: Support granularity of metrics. ,
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Description: Support metric aggregation type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AvailableSkus_List (removed)
Description :  List all the available Skus and information related to them.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ResourceType Sku ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The Sku name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The Sku kind. ,
Required: False ,
}
string ,
tier:
{
Description: The Sku tier. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The Sku kind. ,
Required: False ,
}
string ,
family:
{
Description: The Sku family. ,
Required: False ,
}
string ,
locations:
{
Description: Availability of the Sku for the region. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: The API versions in which Sku is available. ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Availability of the Sku for the location/zone/site. ,
Required: False ,
}
[
{
location:
{
Description: The location. ,
Required: False ,
}
string ,
zones:
{
Description: The zones. ,
Required: False ,
}
[
string ,
]
,
sites:
{
Description: The sites. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
costs:
{
Description: The pricing info of the Sku. ,
Required: False ,
}
[
{
meterId:
{
Description: Used for querying price from commerce. ,
Required: False ,
}
string ,
quantity:
{
Description: The cost quantity. ,
Format: int64 ,
Required: False ,
}
integer ,
extendedUnit:
{
Description: The extended unit. ,
Required: False ,
}
string ,
}
,
]
,
signupOption:
{
Description: Sku can be signed up by customer or not. ,
Enum:
{
None: No description available. ,
Available: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Availability of the Sku as preview/stable. ,
Enum:
{
Stable: No description available. ,
Preview: No description available. ,
}
,
Required: False ,
}
enum ,
availability:
{
Description: Links to the next set of results ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
shipmentTypes:
{
Description: List of Shipment Types supported by this SKU ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The capability info of the SKU. ,
Required: False ,
}
[
{
name:
{
Description: An invariant to describe the feature. ,
Required: False ,
}
string ,
value:
{
Description: An invariant if the feature is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Links to the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_ListBySubscription (removed)
Description :  Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Data Box Edge/Gateway devices. ,
Required: False ,
}
[
{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_ListByResourceGroup (removed)
Description :  Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Data Box Edge/Gateway devices. ,
Required: False ,
}
[
{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_Get (removed)
Description :  Gets the properties of the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_CreateOrUpdate (removed)
Description :  Creates or updates a Data Box Edge/Data Box Gateway resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
dataBoxEdgeDevice:
{
Description: The resource object. ,
Required: True ,
}
{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_Delete (removed)
Description :  Deletes the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_Update (removed)
Description :  Modifies a Data Box Edge/Data Box Gateway resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags attached to the Data Box Edge/Gateway resource. ,
Required: False ,
}
object ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated with the Data Box Edge/Gateway resource ,
Required: False ,
}
{
edgeProfile:
{
Description: Edge Profile property of the Data Box Edge/Gateway device ,
Required: False ,
}
{
subscription:
{
Description: The Data Box Edge/Gateway Edge Profile Subscription patch ,
Required: False ,
}
{
id:
{
Description: The path ID that uniquely identifies the subscription of the edge profile. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). ,
Required: False ,
}
object ,
sku:
{
Description: The SKU type. ,
Required: False ,
}
{
name:
{
Description: SKU name. ,
Enum:
{
Gateway: No description available. ,
Edge: No description available. ,
TEA_1Node: No description available. ,
TEA_1Node_UPS: No description available. ,
TEA_1Node_Heater: No description available. ,
TEA_1Node_UPS_Heater: No description available. ,
TEA_4Node_Heater: No description available. ,
TEA_4Node_UPS_Heater: No description available. ,
TMA: No description available. ,
TDC: No description available. ,
TCA_Small: No description available. ,
GPU: No description available. ,
TCA_Large: No description available. ,
EdgeP_Base: No description available. ,
EdgeP_High: No description available. ,
EdgePR_Base: No description available. ,
EdgePR_Base_UPS: No description available. ,
EP2_64_1VPU_W: No description available. ,
EP2_128_1T4_Mx1_W: No description available. ,
EP2_256_2T4_W: No description available. ,
EdgeMR_Mini: No description available. ,
RCA_Small: No description available. ,
RCA_Large: No description available. ,
RDC: No description available. ,
Management: No description available. ,
EP2_64_Mx1_W: No description available. ,
EP2_128_GPU1_Mx1_W: No description available. ,
EP2_256_GPU2_Mx1: No description available. ,
EdgeMR_TCP: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: The etag for the devices. ,
Required: False ,
}
string ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the device. ,
Enum:
{
AzureDataBoxGateway: No description available. ,
AzureStackEdge: No description available. ,
AzureStackHub: No description available. ,
AzureModularDataCentre: No description available. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: DataBoxEdge Resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the Data Box Edge/Gateway device. ,
Required: False ,
}
{
systemData:
{
Description: DataBoxEdge Device Properties ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
dataBoxEdgeDeviceStatus:
{
Description: The status of the Data Box Edge/Gateway device. ,
Enum:
{
ReadyToSetup: No description available. ,
Online: No description available. ,
Offline: No description available. ,
NeedsAttention: No description available. ,
Disconnected: No description available. ,
PartiallyDisconnected: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The Serial Number of Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
description:
{
Description: The Description of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
modelDescription:
{
Description: The description of the Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceType:
{
Description: The type of the Data Box Edge/Gateway device. ,
Enum:
{
DataBoxEdgeDevice: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: The Data Box Edge/Gateway device name. ,
Required: False ,
}
string ,
culture:
{
Description: The Data Box Edge/Gateway device culture. ,
Required: False ,
}
string ,
deviceModel:
{
Description: The Data Box Edge/Gateway device model. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The Data Box Edge/Gateway device software version. ,
Required: False ,
}
string ,
deviceLocalCapacity:
{
Description: The Data Box Edge/Gateway device local capacity in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The Data Box Edge/Gateway device timezone. ,
Required: False ,
}
string ,
deviceHcsVersion:
{
Description: The device software version number of the device (eg: 1.2.18105.6). ,
Required: False ,
}
string ,
configuredRoleTypes:
{
Description: Type of compute roles configured. ,
Required: False ,
}
[
string ,
]
,
nodeCount:
{
Description: The number of nodes in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceMoveDetails:
{
Description: The details of the move operation on this resource. ,
Required: False ,
}
{
operationInProgress:
{
Description: Denotes whether move operation is in progress ,
Enum:
{
None: No description available. ,
ResourceMoveInProgress: No description available. ,
ResourceMoveFailed: No description available. ,
}
,
Required: False ,
}
enum ,
operationInProgressLockTimeoutInUTC:
{
Description: Denotes the timeout of the operation to finish ,
Format: date-time ,
Required: False ,
}
string ,
}
,
edgeProfile:
{
Description: The details of Edge Profile for this resource ,
Required: False ,
}
{
subscription:
{
Description: Edge Profile Subscription ,
Required: False ,
}
{
registrationId:
{
Description: Edge Subscription Registration ID ,
Required: False ,
}
string ,
id:
{
Description: ARM ID of the subscription ,
Required: False ,
}
string ,
state:
{
Enum:
{
Registered: No description available. ,
Warned: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
Unregistered: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Required: False ,
}
string ,
subscriptionId:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
tenantId:
{
Required: False ,
}
string ,
locationPlacementId:
{
Required: False ,
}
string ,
quotaId:
{
Required: False ,
}
string ,
serializedDetails:
{
Required: False ,
}
string ,
registeredFeatures:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
state:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
dataResidency:
{
Description: The details of data-residency related properties for this resource ,
Required: False ,
}
{
type:
{
Description: DataResidencyType enum ,
Enum:
{
GeoZoneReplication: No description available. ,
ZoneReplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
computeVersionInformation:
{
Description: The details of compute version information ,
Required: False ,
}
{
kubernetesVersion:
{
Description: Kubernetes Version ,
Required: False ,
}
string ,
iotEdgeVersion:
{
Description: IOTEdge Version ,
Required: False ,
}
string ,
azureArcVersion:
{
Description: Azure Arc Version ,
Required: False ,
}
string ,
}
,
kubernetesPlatform:
{
Description: Type of Kubernetes Platform ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Alerts_ListByDataBoxEdgeDevice (removed)
Description :  Gets all the alerts for a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of alert. ,
Required: False ,
}
{
title:
{
Description: Alert title. ,
Required: False ,
}
string ,
alertType:
{
Description: Alert type. ,
Required: False ,
}
string ,
appearedAtDateTime:
{
Description: UTC time when the alert appeared. ,
Format: date-time ,
Required: False ,
}
string ,
recommendation:
{
Description: Alert recommendation. ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the alert. ,
Enum:
{
Informational: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details of the alert. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message. ,
Required: False ,
}
string ,
occurrences:
{
Description: Number of occurrences. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
detailedInformation:
{
Description: Alert details. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Alert ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Alerts_Get (removed)
Description :  Gets an alert by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The alert name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of alert. ,
Required: False ,
}
{
title:
{
Description: Alert title. ,
Required: False ,
}
string ,
alertType:
{
Description: Alert type. ,
Required: False ,
}
string ,
appearedAtDateTime:
{
Description: UTC time when the alert appeared. ,
Format: date-time ,
Required: False ,
}
string ,
recommendation:
{
Description: Alert recommendation. ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the alert. ,
Enum:
{
Informational: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details of the alert. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message. ,
Required: False ,
}
string ,
occurrences:
{
Description: Number of occurrences. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
detailedInformation:
{
Description: Alert details. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Alert ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_ListByDataBoxEdgeDevice (removed)
Description :  Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of bandwidth schedules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_Get (removed)
Description :  Gets the properties of the specified bandwidth schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The bandwidth schedule name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_CreateOrUpdate (removed)
Description :  Creates or updates a bandwidth schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The bandwidth schedule name which needs to be added/updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The bandwidth schedule to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the bandwidth schedule. ,
Required: True ,
}
{
start:
{
Description: The start time of the schedule in UTC. ,
Required: True ,
}
string ,
stop:
{
Description: The stop time of the schedule in UTC. ,
Required: True ,
}
string ,
rateInMbps:
{
Description: The bandwidth rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of BandwidthSchedule ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BandwidthSchedules_Delete (removed)
Description :  Deletes the specified bandwidth schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The bandwidth schedule name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeviceCapacityCheck_CheckResourceCreationFeasibility (removed)
Description :  Posts the device capacity request info to check feasibility.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityCheck
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
deviceCapacityRequestInfo:
{
Description: The device capacity request info. ,
Required: True ,
}
{
properties:
{
Description: The properties of the Device Capacity Request. ,
Required: True ,
}
{
vmPlacementQuery:
{
Description: Array containing the sizes of the VMs for checking if its feasible to create them on the appliance. ,
Required: True ,
}
[
string ,
]
,
vmPlacementResults:
{
Description: Array of the VMs of the sizes in VmSizes can be provisioned on the appliance. ,
Required: False ,
}
[
{
vmSize:
{
Description: List of VM sizes being checked. ,
Required: False ,
}
[
string ,
]
,
isFeasible:
{
Description: Boolean value indicating if the VM(s) in VmSize can be created. ,
Required: False ,
}
boolean ,
messageCode:
{
Description: MessageCode indicating reason for success or failure. ,
Required: False ,
}
string ,
message:
{
Description: Localized message to be displayed to the user to explain the check result. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
capacityName:
{
Description: The capacity name. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeviceCapacityInfo_GetDeviceCapacityInfo (removed)
Description :  Gets the properties of the specified device capacity info.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The device capacity properties. ,
Required: False ,
}
{
timeStamp:
{
Description: Timestamp of request in UTC ,
Format: date-time ,
Required: False ,
}
string ,
clusterStorageCapacityInfo:
{
Description: Cluster capacity data for storage resources (CSV). ,
Required: False ,
}
{
clusterTotalStorageMb:
{
Description: Total storage on the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterFreeStorageMb:
{
Description: The available or free storage on the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
}
,
clusterComputeCapacityInfo:
{
Description: Cluster capacity data for compute resources (Memory and GPU). ,
Required: False ,
}
{
fqdn:
{
Description: The FQDN of the cluster. ,
Required: False ,
}
string ,
gpuCapacity:
{
Description: The cluster's GPU capacity. ,
Required: False ,
}
{
gpuType:
{
Description: The cluster GPU Type. ,
Required: False ,
}
string ,
gpuUsedUnitsCount:
{
Description: The used GPU units count in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
gpuFreeUnitsCount:
{
Description: The free GPU units count in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
gpuReservedForFailoverUnitsCount:
{
Description: The GPU units count reserved for failover in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
gpuTotalUnitsCount:
{
Description: The total GPU units count in the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryCapacity:
{
Description: The cluster's memory capacity. ,
Required: False ,
}
{
clusterFreeMemoryMb:
{
Description: The free memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterUsedMemoryMb:
{
Description: The used memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterFailoverMemoryMb:
{
Description: The failover memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterFragmentationMemoryMb:
{
Description: The fragmentation memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterHypervReserveMemoryMb:
{
Description: The memory reserved for Hyper-V in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterInfraVmMemoryMb:
{
Description: The memory of the Infra VM in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterTotalMemoryMb:
{
Description: The total memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterNonFailoverVmMb:
{
Description: The non-failover memory in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
clusterMemoryUsedByVmsMb:
{
Description: The memory used by VMs in the cluster in MB. ,
Format: double ,
Required: False ,
}
number ,
}
,
lastRefreshedTime:
{
Description: The last time at which the ClusterCapacityViewData was set. ,
Format: date-time ,
Required: False ,
}
string ,
totalProvisionedNonHpnCores:
{
Description: The total # of vCPUs provisioned by non-HPN VM per appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
nodeCapacityInfos:
{
Description: The dictionary of individual node names and node capacities in the cluster. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to device capacity info. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_GetDiagnosticProactiveLogCollectionSettings (removed)
Description :  Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the diagnostic proactive log collection settings. ,
Required: True ,
}
{
userConsent:
{
Description: Proactive diagnostic collection consent flag ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings (removed)
Description :  Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
proactiveLogCollectionSettings:
{
Description: The proactive log collection settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the diagnostic proactive log collection settings. ,
Required: True ,
}
{
userConsent:
{
Description: Proactive diagnostic collection consent flag ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the diagnostic proactive log collection settings. ,
Required: True ,
}
{
userConsent:
{
Description: Proactive diagnostic collection consent flag ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_GetDiagnosticRemoteSupportSettings (removed)
Description :  Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the remote support settings. ,
Required: True ,
}
{
remoteSupportSettingsList:
{
Description: Remote support settings list according to the RemoteApplicationType ,
Required: False ,
}
[
{
remoteApplicationType:
{
Description: Remote application type ,
Enum:
{
Powershell: No description available. ,
WAC: No description available. ,
LocalUI: No description available. ,
AllApplications: No description available. ,
}
,
Required: False ,
}
enum ,
accessLevel:
{
Description: Access level allowed for this remote application type ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
FullAccess: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeStampInUTC:
{
Description: Expiration time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Represents resource creation and updation time ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings (removed)
Description :  Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
diagnosticRemoteSupportSettings:
{
Description: The diagnostic remote support settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the remote support settings. ,
Required: True ,
}
{
remoteSupportSettingsList:
{
Description: Remote support settings list according to the RemoteApplicationType ,
Required: False ,
}
[
{
remoteApplicationType:
{
Description: Remote application type ,
Enum:
{
Powershell: No description available. ,
WAC: No description available. ,
LocalUI: No description available. ,
AllApplications: No description available. ,
}
,
Required: False ,
}
enum ,
accessLevel:
{
Description: Access level allowed for this remote application type ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
FullAccess: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeStampInUTC:
{
Description: Expiration time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Represents resource creation and updation time ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: Properties of the remote support settings. ,
Required: True ,
}
{
remoteSupportSettingsList:
{
Description: Remote support settings list according to the RemoteApplicationType ,
Required: False ,
}
[
{
remoteApplicationType:
{
Description: Remote application type ,
Enum:
{
Powershell: No description available. ,
WAC: No description available. ,
LocalUI: No description available. ,
AllApplications: No description available. ,
}
,
Required: False ,
}
enum ,
accessLevel:
{
Description: Access level allowed for this remote application type ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
FullAccess: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeStampInUTC:
{
Description: Expiration time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Represents resource creation and updation time ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_DownloadUpdates (removed)
Description :  Downloads the updates on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GenerateCertificate (removed)
Description :  Generates certificate for activation key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
publicKey:
{
Description: Gets or sets base64 encoded certificate raw data, this is the public part needed to be uploaded to cert vault ,
Required: False ,
}
string ,
privateKey:
{
Description: Gets or sets base64 encoded private part of the certificate, needed to form the activation key ,
Required: False ,
}
string ,
expiryTimeInUTC:
{
Description: Gets or sets expiry time in UTC ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GetExtendedInformation (removed)
Description :  Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
encryptionKeyThumbprint:
{
Description: The digital signature of encrypted certificate. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: The public part of the encryption certificate. Client uses this to encrypt any secret. ,
Required: False ,
}
string ,
resourceKey:
{
Description: The Resource ID of the Resource. ,
Required: False ,
}
string ,
clientSecretStoreId:
{
Description: The Key Vault ARM Id for client secrets ,
Required: False ,
}
string ,
clientSecretStoreUrl:
{
Description: The url to access the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyName:
{
Description: The name of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyVersion:
{
Description: The version of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
keyVaultSyncStatus:
{
Description: Key vault sync status ,
Enum:
{
KeyVaultSynced: No description available. ,
KeyVaultSyncFailed: No description available. ,
KeyVaultNotConfigured: No description available. ,
KeyVaultSyncPending: No description available. ,
KeyVaultSyncing: No description available. ,
KeyVaultNotSynced: No description available. ,
}
,
Required: False ,
}
enum ,
deviceSecrets:
{
Description: Device secrets, will be returned only with ODataFilter $expand=deviceSecrets ,
Required: False ,
}
object ,
clusterWitnessType:
{
Description: Cluster Witness Type ,
Enum:
{
None: No description available. ,
Cloud: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
fileShareWitnessLocation:
{
Description: The witness location of file share. ,
Required: False ,
}
string ,
fileShareWitnessUsername:
{
Description: The username of file share. ,
Required: False ,
}
string ,
cloudWitnessStorageAccountName:
{
Description: The Cloud Witness Storage account name. ,
Required: False ,
}
string ,
cloudWitnessContainerName:
{
Description: The Container for cloud witness in the storage account. ,
Required: False ,
}
string ,
cloudWitnessStorageEndpoint:
{
Description: The Azure service endpoint of the cloud witness storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DataBoxEdgeDevice ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_InstallUpdates (removed)
Description :  Installs the updates on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_Get (removed)
Description :  Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The job name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The path ID that uniquely identifies the object. ,
Required: False ,
}
string ,
name:
{
Description: The name of the object. ,
Required: False ,
}
string ,
type:
{
Description: The hierarchical type of the object. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is complete. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: The error details. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
Invalid: No description available. ,
ScanForUpdates: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
RefreshShare: No description available. ,
RefreshContainer: No description available. ,
Backup: No description available. ,
Restore: No description available. ,
TriggerSupportPackage: No description available. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current stage of the update operation. ,
Enum:
{
Unknown: No description available. ,
Initial: No description available. ,
ScanStarted: No description available. ,
ScanComplete: No description available. ,
ScanFailed: No description available. ,
DownloadStarted: No description available. ,
DownloadComplete: No description available. ,
DownloadFailed: No description available. ,
InstallStarted: No description available. ,
InstallComplete: No description available. ,
InstallFailed: No description available. ,
RebootInitiated: No description available. ,
Success: No description available. ,
Failure: No description available. ,
RescanStarted: No description available. ,
RescanComplete: No description available. ,
RescanFailed: No description available. ,
}
,
Required: False ,
}
enum ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage completed. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
totalRefreshErrors:
{
Description: Total number of errors encountered during the refresh process. ,
Format: int32 ,
Required: False ,
}
integer ,
errorManifestFile:
{
Description: Local share/remote container relative path to the error manifest file of the refresh. ,
Required: False ,
}
string ,
refreshedEntityId:
{
Description: ARM ID of the entity that was refreshed. ,
Required: False ,
}
string ,
folder:
{
Description: If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GetNetworkSettings (removed)
Description :  Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of network settings of a device. ,
Required: False ,
}
{
networkAdapters:
{
Description: The network adapter list on the device. ,
Required: False ,
}
[
{
adapterId:
{
Description: Instance ID of network adapter. ,
Required: False ,
}
string ,
adapterPosition:
{
Description: Hardware position of network adapter. ,
Required: False ,
}
{
networkGroup:
{
Description: The network group. ,
Enum:
{
None: No description available. ,
NonRDMA: No description available. ,
RDMA: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
index:
{
Description: Logical index of the adapter. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeId:
{
Description: Node ID of the network adapter. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Network adapter name. ,
Required: False ,
}
string ,
label:
{
Description: Hardware label for the adapter. ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address. ,
Required: False ,
}
string ,
linkSpeed:
{
Description: Link speed. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Value indicating whether this adapter is valid. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
rdmaStatus:
{
Description: Value indicating whether this adapter is RDMA capable. ,
Enum:
{
Incapable: No description available. ,
Capable: No description available. ,
}
,
Required: False ,
}
enum ,
dhcpStatus:
{
Description: Value indicating whether this adapter has DHCP enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4Configuration:
{
Description: The IPv4 configuration of the network adapter. ,
Required: False ,
}
{
ipAddress:
{
Description: The IPv4 address of the network adapter. ,
Required: False ,
}
string ,
subnet:
{
Description: The IPv4 subnet of the network adapter. ,
Required: False ,
}
string ,
gateway:
{
Description: The IPv4 gateway of the network adapter. ,
Required: False ,
}
string ,
}
,
ipv6Configuration:
{
Description: The IPv6 configuration of the network adapter. ,
Required: False ,
}
{
ipAddress:
{
Description: The IPv6 address of the network adapter. ,
Required: False ,
}
string ,
prefixLength:
{
Description: The IPv6 prefix of the network adapter. ,
Format: int32 ,
Required: False ,
}
integer ,
gateway:
{
Description: The IPv6 gateway of the network adapter. ,
Required: False ,
}
string ,
}
,
ipv6LinkLocalAddress:
{
Description: The IPv6 local address. ,
Required: False ,
}
string ,
dnsServers:
{
Description: The list of DNS Servers of the device. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of NetworkSettings ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Nodes_ListByDataBoxEdgeDevice (removed)
Description :  Gets all the nodes currently configured under this Data Box Edge device
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Nodes. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the node ,
Required: False ,
}
{
nodeStatus:
{
Description: The current status of the individual node ,
Enum:
{
Unknown: No description available. ,
Up: No description available. ,
Down: No description available. ,
Rebooting: No description available. ,
ShuttingDown: No description available. ,
}
,
Required: False ,
}
enum ,
nodeChassisSerialNumber:
{
Description: Serial number of the Chassis ,
Required: False ,
}
string ,
nodeSerialNumber:
{
Description: Serial number of the individual node ,
Required: False ,
}
string ,
nodeDisplayName:
{
Description: Display Name of the individual node ,
Required: False ,
}
string ,
nodeFriendlySoftwareVersion:
{
Description: Friendly software version name that is currently installed on the node ,
Required: False ,
}
string ,
nodeHcsVersion:
{
Description: HCS version that is currently installed on the node ,
Required: False ,
}
string ,
nodeInstanceId:
{
Description: Guid instance id of the node ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageOffer_ListOffers (removed)
Description :  Returns list of all offers
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/offers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
skuMappings:
{
Required: False ,
}
[
{
catalogPlanId:
{
Required: False ,
}
string ,
marketplaceSkuId:
{
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OperationsStatus_Get (removed)
Description :  Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The job name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The path ID that uniquely identifies the object. ,
Required: False ,
}
string ,
name:
{
Description: The name of the object. ,
Required: False ,
}
string ,
type:
{
Description: The hierarchical type of the object. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is complete. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: The error details. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access. ,
Required: False ,
}
string ,
message:
{
Description: The message that describes the error in detail. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
Invalid: No description available. ,
ScanForUpdates: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
RefreshShare: No description available. ,
RefreshContainer: No description available. ,
Backup: No description available. ,
Restore: No description available. ,
TriggerSupportPackage: No description available. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current stage of the update operation. ,
Enum:
{
Unknown: No description available. ,
Initial: No description available. ,
ScanStarted: No description available. ,
ScanComplete: No description available. ,
ScanFailed: No description available. ,
DownloadStarted: No description available. ,
DownloadComplete: No description available. ,
DownloadFailed: No description available. ,
InstallStarted: No description available. ,
InstallComplete: No description available. ,
InstallFailed: No description available. ,
RebootInitiated: No description available. ,
Success: No description available. ,
Failure: No description available. ,
RescanStarted: No description available. ,
RescanComplete: No description available. ,
RescanFailed: No description available. ,
}
,
Required: False ,
}
enum ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage completed. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
totalRefreshErrors:
{
Description: Total number of errors encountered during the refresh process. ,
Format: int32 ,
Required: False ,
}
integer ,
errorManifestFile:
{
Description: Local share/remote container relative path to the error manifest file of the refresh. ,
Required: False ,
}
string ,
refreshedEntityId:
{
Description: ARM ID of the entity that was refreshed. ,
Required: False ,
}
string ,
folder:
{
Description: If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_ListByDataBoxEdgeDevice (removed)
Description :  Lists all the orders related to a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of orders. ,
Required: False ,
}
[
{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_Get (removed)
Description :  Gets a specific order by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_CreateOrUpdate (removed)
Description :  Creates or updates an order.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default
{
deviceName:
{
Description: The order details of a device. ,
Required: True ,
}
string ,
order:
{
Description: The order to be created or updated. ,
Required: True ,
}
{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: It specify the order api version. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Order ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The order properties. ,
Required: False ,
}
{
orderId:
{
Description: It specify the order resource id. ,
Required: False ,
}
string ,
contactInformation:
{
Description: The contact details. ,
Required: True ,
}
{
contactPerson:
{
Description: The contact person name. ,
Required: True ,
}
string ,
companyName:
{
Description: The name of the company. ,
Required: True ,
}
string ,
phone:
{
Description: The phone number. ,
Required: True ,
}
string ,
emailList:
{
Description: The email list. ,
Required: True ,
}
[
string ,
]
,
}
,
shippingAddress:
{
Description: The shipping address. ,
Required: False ,
}
{
addressLine1:
{
Description: The address line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: The address line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: The address line3. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code. ,
Required: False ,
}
string ,
city:
{
Description: The city name. ,
Required: False ,
}
string ,
state:
{
Description: The state name. ,
Required: False ,
}
string ,
country:
{
Description: The country name. ,
Required: True ,
}
string ,
}
,
currentStatus:
{
Description: Current status of the order. ,
Required: False ,
}
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
orderHistory:
{
Description: List of status changes in the order. ,
Required: False ,
}
[
{
status:
{
Description: Status of the order as per the allowed status types. ,
Enum:
{
Untracked: No description available. ,
AwaitingFulfillment: No description available. ,
AwaitingPreparation: No description available. ,
AwaitingShipment: No description available. ,
Shipped: No description available. ,
Arriving: No description available. ,
Delivered: No description available. ,
ReplacementRequested: No description available. ,
LostDevice: No description available. ,
Declined: No description available. ,
ReturnInitiated: No description available. ,
AwaitingReturnShipment: No description available. ,
ShippedBack: No description available. ,
CollectedAtMicrosoft: No description available. ,
AwaitingPickup: No description available. ,
PickupCompleted: No description available. ,
AwaitingDrop: No description available. ,
}
,
Required: True ,
}
enum ,
updateDateTime:
{
Description: Time of status update. ,
Format: date-time ,
Required: False ,
}
string ,
comments:
{
Description: Comments related to this status change. ,
Required: False ,
}
string ,
trackingInformation:
{
Description: Tracking information related to the state in the ordering flow ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
additionalOrderDetails:
{
Description: Dictionary to hold generic information which is not stored by the already existing properties ,
Required: False ,
}
object ,
}
,
]
,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
deliveryTrackingInfo:
{
Description: Tracking information for the package delivered to the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
returnTrackingInfo:
{
Description: Tracking information for the package returned from the customer whether it has an original or a replacement device. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Serial number of the device being tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier used in the delivery. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking ID of the shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Tracking URL of the shipment. ,
Required: False ,
}
string ,
}
,
]
,
shipmentType:
{
Description: ShipmentType of the order ,
Enum:
{
NotApplicable: No description available. ,
ShippedToCustomer: No description available. ,
SelfPickup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_Delete (removed)
Description :  Deletes the order related to the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Orders_ListDCAccessCode (removed)
Description :  Gets the DCAccess Code
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DCAccessCode properties. ,
Required: False ,
}
{
authCode:
{
Description: DCAccess Code for the Self Managed shipment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImagePublisher_ListPublishers (removed)
Description :  Returns list of publishers
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageOffer_ListOffersbyPublisher (removed)
Description :  Returns List of Offers by Publisher name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
skuMappings:
{
Required: False ,
}
[
{
catalogPlanId:
{
Required: False ,
}
string ,
marketplaceSkuId:
{
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageSku_ListSKUsWithinOffer (removed)
Description :  Returns List of SKUs Within Offer
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
offerId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
skuMappings:
{
Required: False ,
}
[
{
catalogPlanId:
{
Required: False ,
}
string ,
marketplaceSkuId:
{
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageVersion_ListVersionswithinSKU (removed)
Description :  Returns List of Versions within SKU
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
skuName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
offerId:
{
Required: False ,
}
string ,
skuId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageVersion_GetParticularImage (removed)
Description :  Get Particular Image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
skuName:
{
Required: True ,
}
string ,
versionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
publisherId:
{
Required: False ,
}
string ,
offerId:
{
Required: False ,
}
string ,
skuId:
{
Required: False ,
}
string ,
content:
{
Required: False ,
}
string ,
contentVersion:
{
Required: False ,
}
string ,
provisioningState:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceImageSasToken_GetSASToken (removed)
Description :  Returns SASToken
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}/generatesastoken
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
deviceName:
{
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
offerName:
{
Required: True ,
}
string ,
skuName:
{
Required: True ,
}
string ,
versionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
status:
{
Required: False ,
}
string ,
sasUri:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Required: False ,
}
string ,
sasUri:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_ListByDataBoxEdgeDevice (removed)
Description :  Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Value. ,
Required: False ,
}
[
{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Get (removed)
Description :  Gets a specific role by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_CreateOrUpdate (removed)
Description :  Create or update a role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The role name. ,
Required: True ,
}
string ,
role:
{
Description: The role properties. ,
Required: True ,
}
{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Role ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Delete (removed)
Description :  Deletes the role on the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_ListByRole (removed)
Description :  Lists all the addons configured in the role.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Value. ,
Required: False ,
}
[
{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_Get (removed)
Description :  Gets a specific addon by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
addonName:
{
Description: The addon name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_CreateOrUpdate (removed)
Description :  Create or update a addon.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
addonName:
{
Description: The addon name. ,
Required: True ,
}
string ,
addon:
{
Description: The addon properties. ,
Required: True ,
}
{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Addon type. ,
Enum:
{
IotEdge: No description available. ,
ArcForKubernetes: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Addon ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Addons_Delete (removed)
Description :  Deletes the addon on the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
addonName:
{
Description: The addon name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_List (removed)
Description :  Lists metric configurations in a role.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_Get (removed)
Description :  Gets a metric configuration of a role.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_CreateOrUpdate (removed)
Description :  Creates a new metric configuration or updates an existing one for a role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
monitoringMetricConfiguration:
{
Description: The metric configuration. ,
Required: True ,
}
{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The metric setting properties. ,
Required: True ,
}
{
metricConfigurations:
{
Description: The metrics configuration details ,
Required: True ,
}
[
{
resourceId:
{
Description: The Resource ID on which the metrics should be pushed. ,
Required: True ,
}
string ,
mdmAccount:
{
Description: The MDM account to which the counters should be pushed. ,
Required: False ,
}
string ,
metricNameSpace:
{
Description: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified ,
Required: False ,
}
string ,
counterSets:
{
Description: Host name for the IoT hub associated to the device. ,
Required: True ,
}
[
{
counters:
{
Description: The counters that should be collected in this set. ,
Required: True ,
}
[
{
name:
{
Description: The counter name. ,
Required: True ,
}
string ,
instance:
{
Description: The instance from which counter should be collected. ,
Required: False ,
}
string ,
dimensionFilter:
{
Description: The dimension filter. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
additionalDimensions:
{
Description: The additional dimensions to be added to metric. ,
Required: False ,
}
[
{
sourceType:
{
Description: The dimension type. ,
Required: True ,
}
string ,
sourceName:
{
Description: The dimension value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of MonitoringConfiguration ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoringConfig_Delete (removed)
Description :  deletes a new metric configuration for a role.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
roleName:
{
Description: The role name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_ScanForUpdates (removed)
Description :  Scans for updates on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_CreateOrUpdateSecuritySettings (removed)
Description :  Updates the security settings on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the security settings. ,
Required: True ,
}
{
deviceAdminPassword:
{
Description: Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters. ,
Required: True ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_ListByDataBoxEdgeDevice (removed)
Description :  Lists all the shares in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shares. ,
Required: False ,
}
[
{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_Get (removed)
Description :  Gets a share by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_CreateOrUpdate (removed)
Description :  Creates a new share or updates an existing share on the device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
share:
{
Description: The share properties. ,
Required: True ,
}
{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The share properties. ,
Required: True ,
}
{
description:
{
Description: Description for the share. ,
Required: False ,
}
string ,
shareStatus:
{
Description: Current status of the share. ,
Enum:
{
Offline: No description available. ,
Unknown: No description available. ,
OK: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: True ,
}
enum ,
monitoringStatus:
{
Description: Current monitoring status of the share. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
azureContainerInfo:
{
Description: Azure container mapping for the share. ,
Required: False ,
}
{
storageAccountCredentialId:
{
Description: ID of the storage account credential used to access storage. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). ,
Required: True ,
}
string ,
dataFormat:
{
Description: Storage format used for the file represented by the share. ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessProtocol:
{
Description: Access protocol to be used by the share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: True ,
}
enum ,
userAccessRights:
{
Description: Mapping of users and corresponding access rights on the share (required for SMB protocol). ,
Required: False ,
}
[
{
userId:
{
Description: User ID (already existing in the device). ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed for the user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientAccessRights:
{
Description: List of IP addresses and corresponding access rights on the share(required for NFS protocol). ,
Required: False ,
}
[
{
client:
{
Description: IP of the client. ,
Required: True ,
}
string ,
accessPermission:
{
Description: Type of access to be allowed for the client. ,
Enum:
{
NoAccess: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
refreshDetails:
{
Description: Details of the refresh job on this share. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
shareMappings:
{
Description: Share mount point to the role. ,
Required: False ,
}
[
{
shareId:
{
Description: ID of the share mounted to the role VM. ,
Required: True ,
}
string ,
roleId:
{
Description: ID of the role to which share is mounted. ,
Required: False ,
}
string ,
mountPoint:
{
Description: Mount point for the share. ,
Required: False ,
}
string ,
mountType:
{
Description: Mounting type. ,
Enum:
{
Volume: No description available. ,
HostPath: No description available. ,
}
,
Required: False ,
}
enum ,
roleType:
{
Description: Role type. ,
Enum:
{
IOT: No description available. ,
ASA: No description available. ,
Functions: No description available. ,
Cognitive: No description available. ,
MEC: No description available. ,
CloudEdgeManagement: No description available. ,
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataPolicy:
{
Description: Data policy of the share. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Share ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_Delete (removed)
Description :  Deletes the share on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Shares_Refresh (removed)
Description :  Refreshes the share metadata with the data from the cloud.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The share name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_ListByDataBoxEdgeDevice (removed)
Description :  Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_Get (removed)
Description :  Gets the properties of the specified storage account credential.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_CreateOrUpdate (removed)
Description :  Creates or updates the storage account credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
storageAccountCredential:
{
Description: The storage account credential. ,
Required: True ,
}
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
alias:
{
Description: Alias for the storage account. ,
Required: True ,
}
string ,
userName:
{
Description: Username for the storage account. ,
Required: False ,
}
string ,
accountKey:
{
Description: Encrypted storage key. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
connectionString:
{
Description: Connection string for the storage account. Use this string if username and account key are not specified. ,
Required: False ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
blobDomainName:
{
Description: Blob end point for private clouds. ,
Required: False ,
}
string ,
accountType:
{
Description: Type of storage accessed on the storage account. ,
Enum:
{
GeneralPurposeStorage: No description available. ,
BlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Id of the storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccountCredential ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccountCredentials_Delete (removed)
Description :  Deletes the storage account credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_ListByDataBoxEdgeDevice (removed)
Description :  Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of storageAccounts. ,
Required: False ,
}
[
{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_Get (removed)
Description :  Gets a StorageAccount by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_CreateOrUpdate (removed)
Description :  Creates a new StorageAccount or updates an existing StorageAccount on the device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The StorageAccount name. ,
Required: True ,
}
string ,
storageAccount:
{
Description: The StorageAccount properties. ,
Required: True ,
}
{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Storage Account properties. ,
Required: True ,
}
{
description:
{
Description: Description for the storage Account. ,
Required: False ,
}
string ,
storageAccountStatus:
{
Description: Current status of the storage account ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataPolicy:
{
Description: Data policy of the storage Account. ,
Enum:
{
Cloud: No description available. ,
Local: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountCredentialId:
{
Description: Storage Account Credential Id ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: BlobEndpoint of Storage Account ,
Required: False ,
}
string ,
containerCount:
{
Description: The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of StorageAccount ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StorageAccounts_Delete (removed)
Description :  Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The StorageAccount name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_ListByStorageAccount (removed)
Description :  Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The storage Account name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of containers. ,
Required: False ,
}
[
{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Get (removed)
Description :  Gets a container by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_CreateOrUpdate (removed)
Description :  Creates a new container or updates an existing container on the device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
container:
{
Description: The container properties. ,
Required: True ,
}
{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The container properties. ,
Required: True ,
}
{
containerStatus:
{
Description: Current status of the container. ,
Enum:
{
OK: No description available. ,
Offline: No description available. ,
Unknown: No description available. ,
Updating: No description available. ,
NeedsAttention: No description available. ,
}
,
Required: False ,
}
enum ,
dataFormat:
{
Description: DataFormat for Container ,
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AzureFile: No description available. ,
}
,
Required: True ,
}
enum ,
refreshDetails:
{
Description: Details of the refresh job on this container. ,
Required: False ,
}
{
inProgressRefreshJobId:
{
Description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. ,
Required: False ,
}
string ,
lastCompletedRefreshJobTimeInUTC:
{
Description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. ,
Format: date-time ,
Required: False ,
}
string ,
errorManifestFile:
{
Description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
lastJob:
{
Description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The UTC time when container got created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of Container ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Delete (removed)
Description :  Deletes the container on the Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Refresh (removed)
Description :  Refreshes the container metadata with the data from the cloud.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The Storage Account Name ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_ListByDataBoxEdgeDevice (removed)
Description :  Lists all the triggers configured in the device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$filter:
{
Description: Specify $filter='CustomContextTag eq ' to filter on custom context tag property ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of triggers. ,
Required: False ,
}
[
{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_Get (removed)
Description :  Get a specific trigger by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The trigger name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_CreateOrUpdate (removed)
Description :  Creates or updates a trigger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
{
deviceName:
{
Description: Creates or updates a trigger ,
Required: True ,
}
string ,
name:
{
Description: The trigger name. ,
Required: True ,
}
string ,
trigger:
{
Description: The trigger. ,
Required: True ,
}
{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Trigger Kind. ,
Enum:
{
FileEvent: No description available. ,
PeriodicTimerEvent: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: Metadata pertaining to creation and last modification of Trigger ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Triggers_Delete (removed)
Description :  Deletes the trigger on the gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The trigger name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SupportPackages_TriggerSupportPackage (removed)
Description :  Triggers support package on the device
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
triggerSupportPackageRequest:
{
Description: The trigger support package request object ,
Required: True ,
}
{
properties:
{
Description: The TriggerSupportPackageRequest properties. ,
Required: True ,
}
{
minimumTimeStamp:
{
Description: MinimumTimeStamp from where logs need to be collected ,
Format: date-time ,
Required: False ,
}
string ,
maximumTimeStamp:
{
Description: Start of the timespan of the log collection ,
Format: date-time ,
Required: False ,
}
string ,
include:
{
Description: Type of files, which need to be included in the logs This will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived) or a comma separated list of log types that are required ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_UpdateExtendedInformation (removed)
Description :  Gets additional information for the specified Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
parameters:
{
Description: The patch object. ,
Required: True ,
}
{
clientSecretStoreId:
{
Description: The Key Vault ARM Id for client secrets ,
Required: False ,
}
string ,
clientSecretStoreUrl:
{
Description: The url to access the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyName:
{
Description: The name for Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyVersion:
{
Description: The version of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
syncStatus:
{
Description: For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable. ,
Enum:
{
KeyVaultSynced: No description available. ,
KeyVaultSyncFailed: No description available. ,
KeyVaultNotConfigured: No description available. ,
KeyVaultSyncPending: No description available. ,
KeyVaultSyncing: No description available. ,
KeyVaultNotSynced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
encryptionKeyThumbprint:
{
Description: The digital signature of encrypted certificate. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: The public part of the encryption certificate. Client uses this to encrypt any secret. ,
Required: False ,
}
string ,
resourceKey:
{
Description: The Resource ID of the Resource. ,
Required: False ,
}
string ,
clientSecretStoreId:
{
Description: The Key Vault ARM Id for client secrets ,
Required: False ,
}
string ,
clientSecretStoreUrl:
{
Description: The url to access the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyName:
{
Description: The name of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
channelIntegrityKeyVersion:
{
Description: The version of Channel Integrity Key stored in the Client Key Vault ,
Required: False ,
}
string ,
keyVaultSyncStatus:
{
Description: Key vault sync status ,
Enum:
{
KeyVaultSynced: No description available. ,
KeyVaultSyncFailed: No description available. ,
KeyVaultNotConfigured: No description available. ,
KeyVaultSyncPending: No description available. ,
KeyVaultSyncing: No description available. ,
KeyVaultNotSynced: No description available. ,
}
,
Required: False ,
}
enum ,
deviceSecrets:
{
Description: Device secrets, will be returned only with ODataFilter $expand=deviceSecrets ,
Required: False ,
}
object ,
clusterWitnessType:
{
Description: Cluster Witness Type ,
Enum:
{
None: No description available. ,
Cloud: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
fileShareWitnessLocation:
{
Description: The witness location of file share. ,
Required: False ,
}
string ,
fileShareWitnessUsername:
{
Description: The username of file share. ,
Required: False ,
}
string ,
cloudWitnessStorageAccountName:
{
Description: The Cloud Witness Storage account name. ,
Required: False ,
}
string ,
cloudWitnessContainerName:
{
Description: The Container for cloud witness in the storage account. ,
Required: False ,
}
string ,
cloudWitnessStorageEndpoint:
{
Description: The Azure service endpoint of the cloud witness storage account. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of DataBoxEdgeDevice ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_GetUpdateSummary (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The device update information summary. ,
Required: False ,
}
{
deviceVersionNumber:
{
Description: The current version of the device in format: 1.2.17312.13.", ,
Required: False ,
}
string ,
friendlyDeviceVersionName:
{
Description: The current version of the device in text format. ,
Required: False ,
}
string ,
deviceLastScannedDateTime:
{
Description: The last time when a scan was done on the device. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedScanJobDateTime:
{
Description: The time when the last scan job was completed (success/cancelled/failed) on the appliance. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulScanJobTime:
{
Description: Time when the last scan job is successfully completed. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedDownloadJobDateTime:
{
Description: The time when the last Download job was completed (success/cancelled/failed) on the appliance. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedDownloadJobId:
{
Description: JobId of the last ran download job.(Can be success/cancelled/failed) ,
Required: False ,
}
string ,
lastDownloadJobStatus:
{
Description: JobStatus of the last ran download job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSuccessfulInstallJobDateTime:
{
Description: The time when the Last Install job was completed successfully on the appliance ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedInstallJobDateTime:
{
Description: The time when the last Install job was completed (success/cancelled/failed) on the appliance. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedInstallJobId:
{
Description: JobId of the last ran install job.(Can be success/cancelled/failed) ,
Required: False ,
}
string ,
lastInstallJobStatus:
{
Description: JobStatus of the last ran install job. ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
totalNumberOfUpdatesAvailable:
{
Description: The number of updates available for the current device version as per the last device scan. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfUpdatesPendingDownload:
{
Description: The total number of items pending download. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfUpdatesPendingInstall:
{
Description: The total number of items pending install. ,
Format: int32 ,
Required: False ,
}
integer ,
rebootBehavior:
{
Description: Indicates if updates are available and at least one of the updates needs a reboot. ,
Enum:
{
NeverReboots: No description available. ,
RequiresReboot: No description available. ,
RequestReboot: No description available. ,
}
,
Required: False ,
}
enum ,
ongoingUpdateOperation:
{
Description: The current update operation. ,
Enum:
{
None: No description available. ,
Scan: No description available. ,
Download: No description available. ,
Install: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressDownloadJobId:
{
Description: The job ID of the download job in progress. ,
Required: False ,
}
string ,
inProgressInstallJobId:
{
Description: The job ID of the install job in progress. ,
Required: False ,
}
string ,
inProgressDownloadJobStartedDateTime:
{
Description: The time when the currently running download (if any) started. ,
Format: date-time ,
Required: False ,
}
string ,
inProgressInstallJobStartedDateTime:
{
Description: The time when the currently running install (if any) started. ,
Format: date-time ,
Required: False ,
}
string ,
updateTitles:
{
Description: The list of updates available for install. ,
Required: False ,
}
[
string ,
]
,
updates:
{
Description: The list of updates available for install. ,
Required: False ,
}
[
{
updateTitle:
{
Description: Title of the Update ,
Required: False ,
}
string ,
updateSize:
{
Description: Size of the update(In Bytes) ,
Format: double ,
Required: False ,
}
number ,
updateType:
{
Description: Type of the Update ,
Enum:
{
Software: No description available. ,
Kubernetes: No description available. ,
Firmware: No description available. ,
}
,
Required: False ,
}
enum ,
targetVersion:
{
Description: Target Version number ,
Required: False ,
}
string ,
friendlyVersionNumber:
{
Description: Friendly Version Number ,
Required: False ,
}
string ,
estimatedInstallTimeInMins:
{
Description: Estimated Install Time for the update ,
Format: int32 ,
Required: False ,
}
integer ,
rebootBehavior:
{
Description: Indicates if updates are available and at least one of the updates needs a reboot. ,
Enum:
{
NeverReboots: No description available. ,
RequiresReboot: No description available. ,
RequestReboot: No description available. ,
}
,
Required: False ,
}
enum ,
installationImpact:
{
Description: Impact of Installing an updateType ,
Enum:
{
None: No description available. ,
DeviceRebooted: No description available. ,
KubernetesWorkloadsDown: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the update. ,
Enum:
{
DownloadPending: No description available. ,
DownloadStarted: No description available. ,
DownloadCompleted: No description available. ,
InstallStarted: No description available. ,
InstallCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
totalUpdateSizeInBytes:
{
Description: The total size of updates available for download in bytes. ,
Format: double ,
Required: False ,
}
number ,
totalTimeInMinutes:
{
Description: The total time in Minutes ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of UpdateSummary ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Devices_UploadCertificate (removed)
Description :  Uploads registration certificate for the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
parameters:
{
Description: The upload certificate request. ,
Required: True ,
}
{
properties:
{
Description: The Base 64 encoded certificate raw data. ,
Required: True ,
}
{
authenticationType:
{
Description: The authentication type. ,
Enum:
{
Invalid: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The base64 encoded certificate raw data. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authType:
{
Description: Specifies authentication type. ,
Enum:
{
Invalid: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resource ID of the Data Box Edge/Gateway device. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Azure Active Directory tenant authority. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Azure Active Directory tenant ID. ,
Required: False ,
}
string ,
servicePrincipalClientId:
{
Description: Azure Active Directory service principal client ID. ,
Required: False ,
}
string ,
servicePrincipalObjectId:
{
Description: Azure Active Directory service principal object ID. ,
Required: False ,
}
string ,
azureManagementEndpointAudience:
{
Description: The azure management endpoint audience. ,
Required: False ,
}
string ,
aadAudience:
{
Description: Identifier of the target resource that is the recipient of the requested token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_ListByDataBoxEdgeDevice (removed)
Description :  Gets all the users registered on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$filter:
{
Description: Specify $filter='Type eq ' to filter on user type property ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of users. ,
Required: False ,
}
[
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Get (removed)
Description :  Gets the properties of the specified user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The user name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_CreateOrUpdate (removed)
Description :  Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The user name. ,
Required: True ,
}
string ,
user:
{
Description: The user details. ,
Required: True ,
}
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
encryptedPassword:
{
Description: The password details. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
shareAccessRights:
{
Description: List of shares that the user has rights on. This field should not be specified during user creation. ,
Required: False ,
}
[
{
shareId:
{
Description: The share ID. ,
Required: True ,
}
string ,
accessType:
{
Description: Type of access to be allowed on the share for this user. ,
Enum:
{
Change: No description available. ,
Read: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
userType:
{
Description: Type of the user. ,
Enum:
{
Share: No description available. ,
LocalManagement: No description available. ,
ARM: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of User ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Users_Delete (removed)
Description :  Deletes the user on a databox edge/gateway device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
name:
{
Description: The user name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}