Orders - List DC Access Code

Service:

Data Box Edge/Data Box Gateway

API Version:

2021-02-01

Gets the DCAccess Code

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode?api-version=2021-02-01

URI Parameters

Name	In	Required	Type	Description
deviceName	path	True	string	The device name
resourceGroupName	path	True	string	The resource group name.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	The API version.

Responses

Name	Type	Description
200 OK	DCAccessCode	DC Access code for the device
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetDCAccessCode

Sample request

HTTP

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default/listDCAccessCode?api-version=2021-02-01

Sample response

Status code:

200

{
  "properties": {
    "authCode": "_sv7-NY2"
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DCAccessCode	DC Access code in the case of Self Managed Shipping.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	The error details.

CloudErrorBody

Object

An error response from the service.

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

DCAccessCode

Object

DC Access code in the case of Self Managed Shipping.

Name	Type	Description
properties.authCode	string	DCAccess Code for the Self Managed shipment.