models Package

Modules

address
address_py3
alert
alert_error_details
alert_error_details_py3
alert_paged
alert_py3
arm_base_model
arm_base_model_py3
asymmetric_encrypted_secret
asymmetric_encrypted_secret_py3
authentication
authentication_py3
azure_container_info
azure_container_info_py3
bandwidth_schedule
bandwidth_schedule_paged
bandwidth_schedule_py3
client_access_right
client_access_right_py3
contact_details
contact_details_py3
data_box_edge_device
data_box_edge_device_extended_info
data_box_edge_device_extended_info_py3
data_box_edge_device_paged
data_box_edge_device_patch
data_box_edge_device_patch_py3
data_box_edge_device_py3
data_box_edge_management_client_enums
file_event_trigger
file_event_trigger_py3
file_source_info
file_source_info_py3
io_tdevice_info
io_tdevice_info_py3
io_trole
io_trole_py3
ipv4_config
ipv4_config_py3
ipv6_config
ipv6_config_py3
job
job_error_details
job_error_details_py3
job_error_item
job_error_item_py3
job_py3
metric_dimension_v1
metric_dimension_v1_py3
metric_specification_v1
metric_specification_v1_py3
mount_point_map
mount_point_map_py3
network_adapter
network_adapter_position
network_adapter_position_py3
network_adapter_py3
network_settings
network_settings_py3
operation
operation_display
operation_display_py3
operation_paged
operation_py3
order
order_paged
order_py3
order_status
order_status_py3
periodic_timer_event_trigger
periodic_timer_event_trigger_py3
periodic_timer_source_info
periodic_timer_source_info_py3
refresh_details
refresh_details_py3
role
role_paged
role_py3
role_sink_info
role_sink_info_py3
security_settings
security_settings_py3
service_specification
service_specification_py3
share
share_access_right
share_access_right_py3
share_paged
share_py3
sku
sku_py3
storage_account_credential
storage_account_credential_paged
storage_account_credential_py3
symmetric_key
symmetric_key_py3
tracking_info
tracking_info_py3
trigger
trigger_paged
trigger_py3
update_download_progress
update_download_progress_py3
update_install_progress
update_install_progress_py3
update_summary
update_summary_py3
upload_certificate_request
upload_certificate_request_py3
upload_certificate_response
upload_certificate_response_py3
user
user_access_right
user_access_right_py3
user_paged
user_py3

Classes

ARMBaseModel

Represents the base class for all object models.

Variables are only populated by the server, and will be ignored when sending a request.

Address

The shipping address of the customer.

All required parameters must be populated in order to send to Azure.

Alert

Alert on the data box edge/gateway device.

Variables are only populated by the server, and will be ignored when sending a request.

AlertErrorDetails

Error details for the alert.

Variables are only populated by the server, and will be ignored when sending a request.

AlertPaged

A paging container for iterating over a list of Alert object

AsymmetricEncryptedSecret

Represent the secrets intended for encryption with asymmetric key pair.

All required parameters must be populated in order to send to Azure.

Authentication

Authentication mechanism for IoT devices.

AzureContainerInfo

Azure container mapping of the endpoint.

All required parameters must be populated in order to send to Azure.

BandwidthSchedule

The bandwidth schedule details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

BandwidthSchedulePaged

A paging container for iterating over a list of BandwidthSchedule object

ClientAccessRight

The mapping between a particular client IP and the type of access client has on the NFS share.

All required parameters must be populated in order to send to Azure.

ContactDetails

Contains all the contact details of the customer.

All required parameters must be populated in order to send to Azure.

DataBoxEdgeDevice

The Data Box Edge/Gateway device.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxEdgeDeviceExtendedInfo

The extended Info of the Data Box Edge/Gateway device.

Variables are only populated by the server, and will be ignored when sending a request.

DataBoxEdgeDevicePaged

A paging container for iterating over a list of DataBoxEdgeDevice object

DataBoxEdgeDevicePatch

The Data Box Edge/Gateway device patch.

FileEventTrigger

Trigger details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

FileSourceInfo

File source details.

All required parameters must be populated in order to send to Azure.

IoTDeviceInfo

Metadata of IoT device/IoT Edge device to be configured.

All required parameters must be populated in order to send to Azure.

IoTRole

Compute role.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Ipv4Config

Details related to the IPv4 address configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Ipv6Config

Details related to the IPv6 address configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Job

A device job.

Variables are only populated by the server, and will be ignored when sending a request.

JobErrorDetails

The job error information containing the list of job errors.

Variables are only populated by the server, and will be ignored when sending a request.

JobErrorItem

The job error items.

Variables are only populated by the server, and will be ignored when sending a request.

MetricDimensionV1

Metric Dimension v1.

MetricSpecificationV1

Metric specification version 1.

MountPointMap

The share mount point.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

NetworkAdapter

Represents the networkAdapter on a device.

Variables are only populated by the server, and will be ignored when sending a request.

NetworkAdapterPosition

The network adapter position.

Variables are only populated by the server, and will be ignored when sending a request.

NetworkSettings

The network settings of a device.

Variables are only populated by the server, and will be ignored when sending a request.

Operation

Operations.

OperationDisplay

Operation display properties.

OperationPaged

A paging container for iterating over a list of Operation object

Order

The order details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

OrderPaged

A paging container for iterating over a list of Order object

OrderStatus

Represents a single status change.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

PeriodicTimerEventTrigger

Trigger details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

PeriodicTimerSourceInfo

Periodic timer event source.

All required parameters must be populated in order to send to Azure.

RefreshDetails

Fields for tracking refresh job on the share.

Role

Compute role.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: IoTRole

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

RolePaged

A paging container for iterating over a list of Role object

RoleSinkInfo

Compute role against which events will be raised.

All required parameters must be populated in order to send to Azure.

SecuritySettings

The security settings of a device.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ServiceSpecification

Service specification.

Share

Represents a share on the Data Box Edge/Gateway device.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ShareAccessRight

Specifies the mapping between this particular user and the type of access he has on shares on this device.

All required parameters must be populated in order to send to Azure.

SharePaged

A paging container for iterating over a list of Share object

Sku

The SKU type.

StorageAccountCredential

The storage account credential.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

StorageAccountCredentialPaged

A paging container for iterating over a list of StorageAccountCredential object

SymmetricKey

Symmetric key for authentication.

TrackingInfo

Tracking courier information.

Trigger

Trigger details.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FileEventTrigger, PeriodicTimerEventTrigger

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

TriggerPaged

A paging container for iterating over a list of Trigger object

UpdateDownloadProgress

Details about the download progress of update.

Variables are only populated by the server, and will be ignored when sending a request.

UpdateInstallProgress

Progress details during installation of updates.

Variables are only populated by the server, and will be ignored when sending a request.

UpdateSummary

Details about ongoing updates and availability of updates on the device.

Variables are only populated by the server, and will be ignored when sending a request.

UploadCertificateRequest

The upload certificate request.

All required parameters must be populated in order to send to Azure.

UploadCertificateResponse

The upload registration certificate response.

All required parameters must be populated in order to send to Azure.

User

Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.

Variables are only populated by the server, and will be ignored when sending a request.

UserAccessRight

The mapping between a particular user and the access type on the SMB share.

All required parameters must be populated in order to send to Azure.

UserPaged

A paging container for iterating over a list of User object

Enums

AccountType

An enumeration.

AlertSeverity

An enumeration.

AuthenticationType

An enumeration.

AzureContainerDataFormat

An enumeration.

ClientPermissionType

An enumeration.

DataBoxEdgeDeviceStatus

An enumeration.

DataPolicy

An enumeration.

DayOfWeek

An enumeration.

DeviceType

An enumeration.

DownloadPhase

An enumeration.

EncryptionAlgorithm

An enumeration.

InstallRebootBehavior

An enumeration.

JobStatus

An enumeration.

JobType

An enumeration.

MetricAggregationType

An enumeration.

MetricCategory

An enumeration.

MetricUnit

An enumeration.

MonitoringStatus

An enumeration.

NetworkAdapterDHCPStatus

An enumeration.

NetworkAdapterRDMAStatus

An enumeration.

NetworkAdapterStatus

An enumeration.

NetworkGroup

An enumeration.

OrderState

An enumeration.

PlatformType

An enumeration.

RoleStatus

An enumeration.

RoleTypes

An enumeration.

SSLStatus

An enumeration.

ShareAccessProtocol

An enumeration.

ShareAccessType

An enumeration.

ShareStatus

An enumeration.

SkuName

An enumeration.

SkuTier

An enumeration.

TimeGrain

An enumeration.

UpdateOperation

An enumeration.

UpdateOperationStage

An enumeration.