@datafire/azure_databoxedge v3.0.0
@datafire/azure_databoxedge
Client library for DataBoxEdgeManagementClient
Installation and Usage
npm install --save @datafire/azure_databoxedge
let azure_databoxedge = require('@datafire/azure_databoxedge').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Actions
Operations_List
List all the supported operations.
azure_databoxedge.Operations_List({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
: The API version.
- api-version required
Output
- output OperationsList
Devices_ListBySubscription
Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
azure_databoxedge.Devices_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription ID. - api-version required
string
: The API version. - $expand
string
: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.
- subscriptionId required
Output
- output DataBoxEdgeDeviceList
Devices_ListByResourceGroup
Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
azure_databoxedge.Devices_ListByResourceGroup({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version. - $expand
string
: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.
- subscriptionId required
Output
- output DataBoxEdgeDeviceList
Devices_Delete
Deletes the Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_Delete({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Devices_Get
Gets the properties of the Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_Get({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output DataBoxEdgeDevice
Devices_Update
Modifies a Data Box Edge/Data Box Gateway resource.
azure_databoxedge.Devices_Update({
"deviceName": "",
"parameters": {},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - parameters required DataBoxEdgeDevicePatch
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output DataBoxEdgeDevice
Devices_CreateOrUpdate
Creates or updates a Data Box Edge/Data Box Gateway resource.
azure_databoxedge.Devices_CreateOrUpdate({
"deviceName": "",
"DataBoxEdgeDevice": {
"location": ""
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - DataBoxEdgeDevice required DataBoxEdgeDevice
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output DataBoxEdgeDevice
Alerts_ListByDataBoxEdgeDevice
Gets all the alerts for a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Alerts_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output AlertList
Alerts_Get
Gets an alert by name.
azure_databoxedge.Alerts_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The alert name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Alert
BandwidthSchedules_ListByDataBoxEdgeDevice
Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
azure_databoxedge.BandwidthSchedules_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output BandwidthSchedulesList
BandwidthSchedules_Delete
Deletes the specified bandwidth schedule.
azure_databoxedge.BandwidthSchedules_Delete({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The bandwidth schedule name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
BandwidthSchedules_Get
Gets the properties of the specified bandwidth schedule.
azure_databoxedge.BandwidthSchedules_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The bandwidth schedule name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output BandwidthSchedule
BandwidthSchedules_CreateOrUpdate
Creates or updates a bandwidth schedule.
azure_databoxedge.BandwidthSchedules_CreateOrUpdate({
"deviceName": "",
"name": "",
"parameters": {
"properties": {
"start": "",
"stop": "",
"rateInMbps": 0,
"days": []
}
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The bandwidth schedule name which needs to be added/updated. - parameters required BandwidthSchedule
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output BandwidthSchedule
Devices_DownloadUpdates
Downloads the updates on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_DownloadUpdates({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Devices_GetExtendedInformation
Gets additional information for the specified Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_GetExtendedInformation({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Devices_InstallUpdates
Installs the updates on the Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_InstallUpdates({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Jobs_Get
Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Jobs_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The job name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Job
Devices_GetNetworkSettings
Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_GetNetworkSettings({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output NetworkSettings
Nodes_ListByDataBoxEdgeDevice
Gets all the nodes currently configured under this Data Box Edge device
azure_databoxedge.Nodes_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output NodeList
OperationsStatus_Get
Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.OperationsStatus_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The job name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Job
Orders_ListByDataBoxEdgeDevice
Lists all the orders related to a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Orders_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output OrderList
Orders_Delete
Deletes the order related to the device.
azure_databoxedge.Orders_Delete({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Orders_Get
Gets a specific order by name.
azure_databoxedge.Orders_Get({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Order
Orders_CreateOrUpdate
Creates or updates an order.
azure_databoxedge.Orders_CreateOrUpdate({
"deviceName": "",
"order": {},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - order required Order
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Order
Roles_ListByDataBoxEdgeDevice
Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Roles_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output RoleList
Roles_Delete
Deletes the role on the device.
azure_databoxedge.Roles_Delete({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The role name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Roles_Get
Gets a specific role by name.
azure_databoxedge.Roles_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The role name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Role
Roles_CreateOrUpdate
Create or update a role.
azure_databoxedge.Roles_CreateOrUpdate({
"deviceName": "",
"name": "",
"role": {
"kind": ""
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The role name. - role required Role
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Role
Devices_ScanForUpdates
Scans for updates on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_ScanForUpdates({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Devices_CreateOrUpdateSecuritySettings
Updates the security settings on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Devices_CreateOrUpdateSecuritySettings({
"deviceName": "",
"securitySettings": {
"properties": {
"deviceAdminPassword": {
"value": "",
"encryptionAlgorithm": ""
}
}
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - securitySettings required SecuritySettings
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Shares_ListByDataBoxEdgeDevice
Lists all the shares in a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Shares_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output ShareList
Shares_Delete
Deletes the share on the Data Box Edge/Data Box Gateway device.
azure_databoxedge.Shares_Delete({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The share name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Shares_Get
Gets a share by name.
azure_databoxedge.Shares_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The share name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Share
Shares_CreateOrUpdate
Creates a new share or updates an existing share on the device.
azure_databoxedge.Shares_CreateOrUpdate({
"deviceName": "",
"name": "",
"share": {
"properties": {
"shareStatus": "",
"monitoringStatus": "",
"accessProtocol": ""
}
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The share name. - share required Share
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Share
Shares_Refresh
Refreshes the share metadata with the data from the cloud.
azure_databoxedge.Shares_Refresh({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The share name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
StorageAccountCredentials_ListByDataBoxEdgeDevice
Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.
azure_databoxedge.StorageAccountCredentials_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output StorageAccountCredentialList
StorageAccountCredentials_Delete
Deletes the storage account credential.
azure_databoxedge.StorageAccountCredentials_Delete({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The storage account credential name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
StorageAccountCredentials_Get
Gets the properties of the specified storage account credential.
azure_databoxedge.StorageAccountCredentials_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The storage account credential name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output StorageAccountCredential
StorageAccountCredentials_CreateOrUpdate
Creates or updates the storage account credential.
azure_databoxedge.StorageAccountCredentials_CreateOrUpdate({
"deviceName": "",
"name": "",
"storageAccountCredential": {
"properties": {
"alias": "",
"sslStatus": "",
"accountType": ""
}
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The storage account credential name. - storageAccountCredential required StorageAccountCredential
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output StorageAccountCredential
Triggers_ListByDataBoxEdgeDevice
Lists all the triggers configured in the device.
azure_databoxedge.Triggers_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version. - $expand
string
: Specify $filter='CustomContextTag eq ' to filter on custom context tag property
- deviceName required
Output
- output TriggerList
Triggers_Delete
Deletes the trigger on the gateway device.
azure_databoxedge.Triggers_Delete({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The trigger name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Triggers_Get
Get a specific trigger by name.
azure_databoxedge.Triggers_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The trigger name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Trigger
Triggers_CreateOrUpdate
Creates or updates a trigger.
azure_databoxedge.Triggers_CreateOrUpdate({
"deviceName": "",
"name": "",
"trigger": {
"kind": ""
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: Creates or updates a trigger - name required
string
: The trigger name. - trigger required Trigger
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output Trigger
Devices_GetUpdateSummary
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.
azure_databoxedge.Devices_GetUpdateSummary({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output UpdateSummary
Devices_UploadCertificate
Uploads registration certificate for the device.
azure_databoxedge.Devices_UploadCertificate({
"deviceName": "",
"parameters": {
"properties": {
"certificate": ""
}
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - parameters required UploadCertificateRequest
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output UploadCertificateResponse
Users_ListByDataBoxEdgeDevice
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Users_ListByDataBoxEdgeDevice({
"deviceName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output UserList
Users_Delete
Deletes the user on a databox edge/gateway device.
azure_databoxedge.Users_Delete({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The user name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
Output schema unknown
Users_Get
Gets the properties of the specified user.
azure_databoxedge.Users_Get({
"deviceName": "",
"name": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The user name. - subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output User
Users_CreateOrUpdate
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
azure_databoxedge.Users_CreateOrUpdate({
"deviceName": "",
"name": "",
"user": {
"properties": {}
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- deviceName required
string
: The device name. - name required
string
: The user name. - user required User
- subscriptionId required
string
: The subscription ID. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- deviceName required
Output
- output User
Definitions
ARMBaseModel
- ARMBaseModel
object
: Represents the base class for all object models.- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- id
Address
- Address
object
: The shipping address of the customer.- addressLine1 required
string
: The address line1. - addressLine2
string
: The address line2. - addressLine3
string
: The address line3. - city required
string
: The city name. - country required
string
: The country name. - postalCode required
string
: The postal code. - state required
string
: The state name.
- addressLine1 required
Alert
- Alert
object
: Alert on the data box edge/gateway device.- properties AlertProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
AlertErrorDetails
- AlertErrorDetails
object
: Error details for the alert.- errorCode
string
: Error code. - errorMessage
string
: Error Message. - occurrences
integer
: Number of occurrences.
- errorCode
AlertList
- AlertList
object
: Collection of alerts.- nextLink
string
: Link to the next set of results. - value
array
: The value.- items Alert
- nextLink
AlertProperties
- AlertProperties
object
: Properties of alert.- alertType
string
: Alert type. - appearedAtDateTime
string
: UTC time when the alert appeared. - detailedInformation
object
: Alert details. - errorDetails AlertErrorDetails
- recommendation
string
: Alert recommendation. - severity
string
(values: Informational, Warning, Critical): Severity of the alert. - title
string
: Alert title.
- alertType
AsymmetricEncryptedSecret
- AsymmetricEncryptedSecret
object
: Represent the secrets intended for encryption with asymmetric key pair.- encryptionAlgorithm required
string
(values: None, AES256, RSAES_PKCS1_v_1_5): The algorithm used to encrypt "Value". - encryptionCertThumbprint
string
: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. - value required
string
: The value of the secret.
- encryptionAlgorithm required
Authentication
- Authentication
object
: Authentication mechanism for IoT devices.- symmetricKey SymmetricKey
AzureContainerInfo
- AzureContainerInfo
object
: Azure container mapping of the endpoint.- containerName required
string
: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). - dataFormat required
string
(values: BlockBlob, PageBlob, AzureFile): Storage format used for the file represented by the share. - storageAccountCredentialId required
string
: ID of the storage account credential used to access storage.
- containerName required
BandwidthSchedule
- BandwidthSchedule
object
: The bandwidth schedule details.- properties required BandwidthScheduleProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
BandwidthScheduleProperties
- BandwidthScheduleProperties
object
: The properties of the bandwidth schedule.- days required
array
: The days of the week when this schedule is applicable.- items
string
(values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday)
- items
- rateInMbps required
integer
: The bandwidth rate in Mbps. - start required
string
: The start time of the schedule in UTC. - stop required
string
: The stop time of the schedule in UTC.
- days required
BandwidthSchedulesList
- BandwidthSchedulesList
object
: The collection of bandwidth schedules.- nextLink
string
: Link to the next set of results. - value
array
: The list of bandwidth schedules.- items BandwidthSchedule
- nextLink
ClientAccessRight
- ClientAccessRight
object
: The mapping between a particular client IP and the type of access client has on the NFS share.- accessPermission required
string
(values: NoAccess, ReadOnly, ReadWrite): Type of access to be allowed for the client. - client required
string
: IP of the client.
- accessPermission required
CloudError
- CloudError
object
: An error response from the service.- error CloudErrorBody
CloudErrorBody
- CloudErrorBody
object
: An error response from the service.- code
string
: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. - details
array
: A list of additional details about the error.- items CloudErrorBody
- message
string
: A message describing the error, intended to be suitable for display in a user interface.
- code
ContactDetails
- ContactDetails
object
: Contains all the contact details of the customer.- companyName required
string
: The name of the company. - contactPerson required
string
: The contact person name. - emailList required
array
: The email list.- items
string
- items
- phone required
string
: The phone number.
- companyName required
DataBoxEdgeDevice
- DataBoxEdgeDevice
object
: The Data Box Edge/Gateway device.- etag
string
: The etag for the devices. - location required
string
: 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. - properties DataBoxEdgeDeviceProperties
- sku Sku
- tags
object
: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). - id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- etag
DataBoxEdgeDeviceExtendedInfo
- DataBoxEdgeDeviceExtendedInfo
object
: The extended Info of the Data Box Edge/Gateway device.- properties DataBoxEdgeDeviceExtendedInfoProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
DataBoxEdgeDeviceExtendedInfoProperties
- DataBoxEdgeDeviceExtendedInfoProperties
object
: The properties of the Data Box Edge/Gateway device extended info.- encryptionKey
string
: The public part of the encryption certificate. Client uses this to encrypt any secret. - encryptionKeyThumbprint
string
: The digital signature of encrypted certificate. - resourceKey
string
: The Resource ID of the Resource.
- encryptionKey
DataBoxEdgeDeviceList
- DataBoxEdgeDeviceList
object
: The collection of Data Box Edge/Gateway devices.- nextLink
string
: Link to the next set of results. - value
array
: The list of Data Box Edge/Gateway devices.- items DataBoxEdgeDevice
- nextLink
DataBoxEdgeDevicePatch
- DataBoxEdgeDevicePatch
object
: The Data Box Edge/Gateway device patch.- tags
object
: The tags attached to the Data Box Edge/Gateway resource.
- tags
DataBoxEdgeDeviceProperties
- DataBoxEdgeDeviceProperties
object
: The properties of the Data Box Edge/Gateway device.- configuredRoleTypes
array
: Type of compute roles configured.- items
string
(values: IOT, ASA, Functions, Cognitive)
- items
- culture
string
: The Data Box Edge/Gateway device culture. - dataBoxEdgeDeviceStatus
string
(values: ReadyToSetup, Online, Offline, NeedsAttention, Disconnected, PartiallyDisconnected, Maintenance): The status of the Data Box Edge/Gateway device. - description
string
: The Description of the Data Box Edge/Gateway device. - deviceHcsVersion
string
: The device software version number of the device (eg: 1.2.18105.6). - deviceLocalCapacity
integer
: The Data Box Edge/Gateway device local capacity in MB. - deviceModel
string
: The Data Box Edge/Gateway device model. - deviceSoftwareVersion
string
: The Data Box Edge/Gateway device software version. - deviceType
string
(values: DataBoxEdgeDevice): The type of the Data Box Edge/Gateway device. - friendlyName
string
: The Data Box Edge/Gateway device name. - modelDescription
string
: The description of the Data Box Edge/Gateway device model. - nodeCount
integer
: The number of nodes in the cluster. - serialNumber
string
: The Serial Number of Data Box Edge/Gateway device. - timeZone
string
: The Data Box Edge/Gateway device timezone.
- configuredRoleTypes
FileEventTrigger
- FileEventTrigger
object
: Trigger details.- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - properties required FileTriggerProperties
- type
string
: The hierarchical type of the object. - kind required
string
(values: FileEvent, PeriodicTimerEvent): Trigger Kind. - id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- id
FileSourceInfo
- FileSourceInfo
object
: File source details.- shareId required
string
: File share ID.
- shareId required
FileTriggerProperties
- FileTriggerProperties
object
: File trigger properties.- customContextTag
string
: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. - sinkInfo required RoleSinkInfo
- sourceInfo required FileSourceInfo
- customContextTag
IoTDeviceInfo
- IoTDeviceInfo
object
: Metadata of IoT device/IoT Edge device to be configured.- authentication Authentication
- deviceId required
string
: ID of the IoT device/edge device. - ioTHostHub required
string
: Host name for the IoT hub associated to the device. - ioTHostHubId
string
: Id of the IoT hub associated to the device.
IoTRole
- IoTRole
object
: Compute role.- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - properties IoTRoleProperties
- type
string
: The hierarchical type of the object. - kind required
string
(values: IOT, ASA, Functions, Cognitive): Role type. - id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- id
IoTRoleProperties
- IoTRoleProperties
object
: IoT role properties.- hostPlatform required
string
(values: Windows, Linux): Host OS supported by the IoT role. - ioTDeviceDetails required IoTDeviceInfo
- ioTEdgeDeviceDetails required IoTDeviceInfo
- roleStatus required
string
(values: Enabled, Disabled): Role status. - shareMappings
array
: Mount points of shares in role(s).- items MountPointMap
- hostPlatform required
Ipv4Config
- Ipv4Config
object
: Details related to the IPv4 address configuration.- gateway
string
: The IPv4 gateway of the network adapter. - ipAddress
string
: The IPv4 address of the network adapter. - subnet
string
: The IPv4 subnet of the network adapter.
- gateway
Ipv6Config
- Ipv6Config
object
: Details related to the IPv6 address configuration.- gateway
string
: The IPv6 gateway of the network adapter. - ipAddress
string
: The IPv6 address of the network adapter. - prefixLength
integer
: The IPv6 prefix of the network adapter.
- gateway
Job
- Job
object
: A device job.- endTime
string
: The UTC date and time at which the job completed. - error JobErrorDetails
- id
string
: The path ID that uniquely identifies the object. - name
string
: The name of the object. - percentComplete
integer
: The percentage of the job that is complete. - properties JobProperties
- startTime
string
: The UTC date and time at which the job started. - status
string
(values: Invalid, Running, Succeeded, Failed, Canceled, Paused, Scheduled): The current status of the job. - type
string
: The hierarchical type of the object.
- endTime
JobErrorDetails
- JobErrorDetails
object
: The job error information containing the list of job errors.- code
string
: The code intended for programmatic access. - errorDetails
array
: The error details.- items JobErrorItem
- message
string
: The message that describes the error in detail.
- code
JobErrorItem
- JobErrorItem
object
: The job error items.- code
string
: The code intended for programmatic access. - message
string
: The message that describes the error in detail. - recommendations
array
: The recommended actions.- items
string
- items
- code
JobProperties
- JobProperties
object
: The properties for the job.- currentStage
string
(values: Unknown, Initial, ScanStarted, ScanComplete, ScanFailed, DownloadStarted, DownloadComplete, DownloadFailed, InstallStarted, InstallComplete, InstallFailed, RebootInitiated, Success, Failure, RescanStarted, RescanComplete, RescanFailed): Current stage of the update operation. - downloadProgress UpdateDownloadProgress
- errorManifestFile
string
: Local share/remote container relative path to the error manifest file of the refresh. - folder
string
: If only subfolders need to be refreshed, then the subfolder path inside the share. (The path is empty if there are no subfolders.) - installProgress UpdateInstallProgress
- jobType
string
(values: Invalid, ScanForUpdates, DownloadUpdates, InstallUpdates, RefreshShare): The type of the job. - shareId
string
: ARM ID of the share that was refreshed. - totalRefreshErrors
integer
: Total number of errors encountered during the refresh process.
- currentStage
MetricDimension_V1
- MetricDimension_V1
object
: Metric Dimension v1.- displayName
string
: Display name of the metrics dimension. - name
string
: Name of the metrics dimension. - toBeExportedForShoebox
boolean
: To be exported to shoe box.
- displayName
MetricSpecification_V1
- MetricSpecification_V1
object
: Metric specification version 1.- aggregationType
string
(values: NotSpecified, None, Average, Minimum, Maximum, Total, Count): Metric aggregation type. - category
string
(values: Capacity, Transaction): Metric category. - dimensions
array
: Metric dimensions, other than default dimension which is resource.- items MetricDimension_V1
- displayDescription
string
: Description of the metric to be displayed. - displayName
string
: Display name of the metric. - fillGapWithZero
boolean
: Set true to fill the gaps with zero. - name
string
: Name of the metric. - resourceIdDimensionNameOverride
string
: Resource name override. - supportedAggregationTypes
array
: Support metric aggregation type.- items
string
(values: NotSpecified, None, Average, Minimum, Maximum, Total, Count)
- items
- supportedTimeGrainTypes
array
: Support granularity of metrics.- items
string
(values: PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, PT1D)
- items
- unit
string
(values: NotSpecified, Percent, Count, Seconds, Milliseconds, Bytes, BytesPerSecond, CountPerSecond): Metric units.
- aggregationType
MountPointMap
- MountPointMap
object
: The share mount point.- mountPoint
string
: Mount point for the share. - roleId
string
: ID of the role to which share is mounted. - roleType
string
(values: IOT, ASA, Functions, Cognitive): Role type. - shareId required
string
: ID of the share mounted to the role VM.
- mountPoint
NetworkAdapter
- NetworkAdapter
object
: Represents the networkAdapter on a device.- adapterId
string
: Instance ID of network adapter. - adapterPosition NetworkAdapterPosition
- dhcpStatus
string
(values: Disabled, Enabled): Value indicating whether this adapter has DHCP enabled. - dnsServers
array
: The list of DNS Servers of the device.- items
string
- items
- index
integer
: Logical index of the adapter. - ipv4Configuration Ipv4Config
- ipv6Configuration Ipv6Config
- ipv6LinkLocalAddress
string
: The IPv6 local address. - label
string
: Hardware label for the adapter. - linkSpeed
integer
: Link speed. - macAddress
string
: MAC address. - networkAdapterName
string
: Network adapter name. - nodeId
string
: Node ID of the network adapter. - rdmaStatus
string
(values: Incapable, Capable): Value indicating whether this adapter is RDMA capable. - status
string
(values: Inactive, Active): Value indicating whether this adapter is valid.
- adapterId
NetworkAdapterPosition
- NetworkAdapterPosition
object
: The network adapter position.- networkGroup
string
(values: None, NonRDMA, RDMA): The network group. - port
integer
: The port.
- networkGroup
NetworkSettings
- NetworkSettings
object
: The network settings of a device.- properties NetworkSettingsProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
NetworkSettingsProperties
- NetworkSettingsProperties
object
: The properties of network settings.- networkAdapters
array
: The network adapter list on the device.- items NetworkAdapter
- networkAdapters
Node
- Node
object
: Represents a single node in a Data box Edge/Gateway device- properties NodeProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
NodeList
- NodeList
object
: Collection of Nodes.- value
array
: The list of Nodes.- items Node
- value
NodeProperties
- NodeProperties
object
: This class represents the nodes in a highly available cluster- nodeChassisSerialNumber
string
: Serial number of the Chassis - nodeDisplayName
string
: Display Name of the individual node - nodeFriendlySoftwareVersion
string
: Friendly software version name that is currently installed on the node - nodeHcsVersion
string
: HCS version that is currently installed on the node - nodeInstanceId
string
: Guid instance id of the node - nodeSerialNumber
string
: Serial number of the individual node - nodeStatus
string
(values: Unknown, Up, Down, Rebooting, ShuttingDown): The current status of the individual node
- nodeChassisSerialNumber
Operation
- Operation
object
: Operations.- display OperationDisplay
- name
string
: Name of the operation. - origin
string
: Origin of the operation. - properties OperationProperties
OperationDisplay
- OperationDisplay
object
: Operation display properties.- description
string
: Description of the operation to be performed. - operation
string
: Operation to be performed on the resource. - provider
string
: Provider name. - resource
string
: The type of resource in which the operation is performed.
- description
OperationProperties
- OperationProperties
object
: Operation properties.- serviceSpecification ServiceSpecification
OperationsList
- OperationsList
object
: The list of operations used for the discovery of available provider operations.- nextLink
string
: Link to the next set of results. - value required
array
: The value.- items Operation
- nextLink
Order
- Order
object
: The order details.- properties OrderProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
OrderList
- OrderList
object
: List of order entities.- nextLink
string
: Link to the next set of results. - value
array
: The list of orders.- items Order
- nextLink
OrderProperties
- OrderProperties
object
: Order properties.- contactInformation required ContactDetails
- currentStatus OrderStatus
- deliveryTrackingInfo
array
: Tracking information for the package delivered to the customer whether it has an original or a replacement device.- items TrackingInfo
- orderHistory
array
: List of status changes in the order.- items OrderStatus
- returnTrackingInfo
array
: Tracking information for the package returned from the customer whether it has an original or a replacement device.- items TrackingInfo
- serialNumber
string
: Serial number of the device. - shippingAddress required Address
OrderStatus
- OrderStatus
object
: Represents a single status change.- comments
string
: Comments related to this status change. - status required
string
(values: Untracked, AwaitingFulfilment, AwaitingPreparation, AwaitingShipment, Shipped, Arriving, Delivered, ReplacementRequested, LostDevice, Declined, ReturnInitiated, AwaitingReturnShipment, ShippedBack, CollectedAtMicrosoft): Status of the order as per the allowed status types. - updateDateTime
string
: Time of status update.
- comments
PeriodicTimerEventTrigger
- PeriodicTimerEventTrigger
object
: Trigger details.- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - properties required PeriodicTimerProperties
- type
string
: The hierarchical type of the object. - kind required
string
(values: FileEvent, PeriodicTimerEvent): Trigger Kind. - id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- id
PeriodicTimerProperties
- PeriodicTimerProperties
object
: Periodic timer trigger properties.- customContextTag
string
: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. - sinkInfo required RoleSinkInfo
- sourceInfo required PeriodicTimerSourceInfo
- customContextTag
PeriodicTimerSourceInfo
- PeriodicTimerSourceInfo
object
: Periodic timer event source.- schedule required
string
: Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. - startTime required
string
: The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. - topic
string
: Topic where periodic events are published to IoT device.
- schedule required
RawCertificateData
- RawCertificateData
object
: Raw Certificate Data.- authenticationType
string
(values: Invalid, AzureActiveDirectory): The authentication type. - certificate required
string
: The base64 encoded certificate raw data.
- authenticationType
RefreshDetails
- RefreshDetails
object
: Fields for tracking refresh job on the share.- errorManifestFile
string
: Indicates the relative path of the error xml for the last refresh job on this particular share, if any. This could be a failed job or a successful job. - inProgressRefreshJobId
string
: If a refresh share job is currently in progress on this share, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. - lastCompletedRefreshJobTimeInUTC
string
: Indicates the completed time for the last refresh job on this particular share, if any.This could be a failed job or a successful job. - lastJob
string
: Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job.
- errorManifestFile
Role
- Role
object
: Compute role.- kind required
string
(values: IOT, ASA, Functions, Cognitive): Role type. - id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- kind required
RoleList
- RoleList
object
: Collection of all the roles on the Data Box Edge device.- nextLink
string
: Link to the next set of results. - value
array
: The Value.- items Role
- nextLink
RoleSinkInfo
- RoleSinkInfo
object
: Compute role against which events will be raised.- roleId required
string
: Compute role ID.
- roleId required
SecuritySettings
- SecuritySettings
object
: The security settings of a device.- properties required SecuritySettingsProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
SecuritySettingsProperties
- SecuritySettingsProperties
object
: The properties of security settings.- deviceAdminPassword required AsymmetricEncryptedSecret
ServiceSpecification
- ServiceSpecification
object
: Service specification.- metricSpecifications
array
: Metric specification as defined by shoebox.- items MetricSpecification_V1
- metricSpecifications
Share
- Share
object
: Represents a share on the Data Box Edge/Gateway device.- properties required ShareProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
ShareAccessRight
- ShareAccessRight
object
: Specifies the mapping between this particular user and the type of access he has on shares on this device.- accessType required
string
(values: Change, Read, Custom): Type of access to be allowed on the share for this user. - shareId required
string
: The share ID.
- accessType required
ShareList
- ShareList
object
: Collection of all the shares on the Data Box Edge/Gateway device.- nextLink
string
: Link to the next set of results. - value
array
: The list of shares.- items Share
- nextLink
ShareProperties
- ShareProperties
object
: The share properties.- accessProtocol required
string
(values: SMB, NFS): Access protocol to be used by the share. - azureContainerInfo AzureContainerInfo
- clientAccessRights
array
: List of IP addresses and corresponding access rights on the share(required for NFS protocol).- items ClientAccessRight
- dataPolicy
string
(values: Cloud, Local): Data policy of the share. - description
string
: Description for the share. - monitoringStatus required
string
(values: Enabled, Disabled): Current monitoring status of the share. - refreshDetails RefreshDetails
- shareMappings
array
: Share mount point to the role.- items MountPointMap
- shareStatus required
string
(values: Offline, Unknown, OK, Updating, NeedsAttention): Current status of the share. - userAccessRights
array
: Mapping of users and corresponding access rights on the share (required for SMB protocol).- items UserAccessRight
- accessProtocol required
Sku
- Sku
object
: The SKU type.- name
string
(values: Gateway, Edge): SKU name. - tier
string
(values: Standard): The SKU tier. This is based on the SKU name.
- name
StorageAccountCredential
- StorageAccountCredential
object
: The storage account credential.- properties required StorageAccountCredentialProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
StorageAccountCredentialList
- StorageAccountCredentialList
object
: The collection of storage account credentials.- nextLink
string
: Link to the next set of results. - value
array
: The value.- items StorageAccountCredential
- nextLink
StorageAccountCredentialProperties
- StorageAccountCredentialProperties
object
: The storage account credential properties.- accountKey AsymmetricEncryptedSecret
- accountType required
string
(values: GeneralPurposeStorage, BlobStorage): Type of storage accessed on the storage account. - alias required
string
: Alias for the storage account. - blobDomainName
string
: Blob end point for private clouds. - connectionString
string
: Connection string for the storage account. Use this string if username and account key are not specified. - sslStatus required
string
(values: Enabled, Disabled): Signifies whether SSL needs to be enabled or not. - storageAccountId
string
: Id of the storage account. - userName
string
: Username for the storage account.
SymmetricKey
- SymmetricKey
object
: Symmetric key for authentication.- connectionString AsymmetricEncryptedSecret
TrackingInfo
- TrackingInfo
object
: Tracking courier information.- carrierName
string
: Name of the carrier used in the delivery. - serialNumber
string
: Serial number of the device being tracked. - trackingId
string
: Tracking ID of the shipment. - trackingUrl
string
: Tracking URL of the shipment.
- carrierName
Trigger
- Trigger
object
: Trigger details.- kind required
string
(values: FileEvent, PeriodicTimerEvent): Trigger Kind. - id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
- kind required
TriggerList
- TriggerList
object
: Collection of all trigger on the data box edge device.- nextLink
string
: Link to the next set of results. - value
array
: The list of triggers.- items Trigger
- nextLink
UpdateDownloadProgress
- UpdateDownloadProgress
object
: Details about the download progress of update.- downloadPhase
string
(values: Unknown, Initializing, Downloading, Verifying): The download phase. - numberOfUpdatesDownloaded
integer
: Number of updates downloaded. - numberOfUpdatesToDownload
integer
: Number of updates to download. - percentComplete
integer
: Percentage of completion. - totalBytesDownloaded
number
: Total bytes downloaded. - totalBytesToDownload
number
: Total bytes to download.
- downloadPhase
UpdateInstallProgress
- UpdateInstallProgress
object
: Progress details during installation of updates.- numberOfUpdatesInstalled
integer
: Number of updates installed. - numberOfUpdatesToInstall
integer
: Number of updates to install. - percentComplete
integer
: Percentage completed.
- numberOfUpdatesInstalled
UpdateSummary
- UpdateSummary
object
: Details about ongoing updates and availability of updates on the device.- properties UpdateSummaryProperties
- id
string
: The path ID that uniquely identifies the object. - name
string
: The object name. - type
string
: The hierarchical type of the object.
UpdateSummaryProperties
- UpdateSummaryProperties
object
: The device update information summary.- deviceLastScannedDateTime
string
: The last time when a scan was done on the device. - deviceVersionNumber
string
: The current version of the device in format: 1.2.17312.13.", - friendlyDeviceVersionName
string
: The current version of the device in text format. - inProgressDownloadJobId
string
: The job ID of the download job in progress. - inProgressDownloadJobStartedDateTime
string
: The time when the currently running download (if any) started. - inProgressInstallJobId
string
: The job ID of the install job in progress. - inProgressInstallJobStartedDateTime
string
: The time when the currently running install (if any) started. - lastCompletedDownloadJobDateTime
string
: The time when the last Download job was completed (success/cancelled/failed) on the appliance. - lastCompletedInstallJobDateTime
string
: The time when the last Install job was completed (success/cancelled/failed) on the appliance. - lastCompletedScanJobDateTime
string
: The time when the last scan job was completed (success/cancelled/failed) on the appliance. - ongoingUpdateOperation
string
(values: None, Scan, Download, Install): The current update operation. - rebootBehavior
string
(values: NeverReboots, RequiresReboot, RequestReboot): Indicates if updates are available and at least one of the updates needs a reboot. - totalNumberOfUpdatesAvailable
integer
: The number of updates available for the current device version as per the last device scan. - totalNumberOfUpdatesPendingDownload
integer
: The total number of items pending download. - totalNumberOfUpdatesPendingInstall
integer
: The total number of items pending install. - totalUpdateSizeInBytes
number
: The total size of updates available for download in bytes. - updateTitles
array
: The list of updates available for install.- items
string
- items
- deviceLastScannedDateTime
UploadCertificateRequest
- UploadCertificateRequest
object
: The upload certificate request.- properties required RawCertificateData
UploadCertificateResponse
- UploadCertificateResponse
object
: The upload registration certificate response.- aadAuthority required
string
: Azure Active Directory tenant authority. - aadTenantId required
string
: Azure Active Directory tenant ID. - authType
string
(values: Invalid, AzureActiveDirectory): Specifies authentication type. - azureManagementEndpointAudience required
string
: The azure management endpoint audience. - resourceId required
string
: The resource ID of the Data Box Edge/Gateway device. - servicePrincipalClientId required
string
: Azure Active Directory service principal client ID. - servicePrincipalObjectId required
string
: Azure Active Directory service principal object ID.
- aadAuthority required
User
- User
object
: Represents a user who has access to one or more shares on the Dat
5 years ago