models Package

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.
Addon	Role Addon. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ArcAddon, IoTAddon. 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.
AddonList	Collection of all the Role addon on the Azure Stack Edge device. 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.
AlertList	Collection of alerts. Variables are only populated by the server, and will be ignored when sending a request.
ArcAddon	Arc Addon. 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.
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.
BandwidthSchedulesList	The collection of bandwidth schedules. Variables are only populated by the server, and will be ignored when sending a request.
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.
CloudEdgeManagementRole	CloudEdgeManagementRole 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.
CloudErrorBody	An error response from the service.
CniConfig	Cni configuration. Variables are only populated by the server, and will be ignored when sending a request.
ComputeResource	Compute infrastructure Resource. 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.
Container	Represents a container 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.
ContainerList	Collection of all the containers on the Data Box Edge/Gateway device. Variables are only populated by the server, and will be ignored when sending a request.
DCAccessCode	DC Access code in the case of Self Managed Shipping.
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.
DataBoxEdgeDeviceExtendedInfoPatch	The Data Box Edge/Gateway device extended info patch.
DataBoxEdgeDeviceList	The collection of Data Box Edge/Gateway devices. Variables are only populated by the server, and will be ignored when sending a request.
DataBoxEdgeDevicePatch	The Data Box Edge/Gateway device patch.
DataBoxEdgeMoveRequest	Resource Move details. All required parameters must be populated in order to send to Azure.
DataBoxEdgeSku	The Sku information. Variables are only populated by the server, and will be ignored when sending a request.
DataBoxEdgeSkuList	List of SKU Information objects. Variables are only populated by the server, and will be ignored when sending a request.
EdgeProfile	Details about Edge Profile for the resource.
EdgeProfilePatch	The Data Box Edge/Gateway Edge Profile patch.
EdgeProfileSubscription	Subscription details for the Edge Profile.
EdgeProfileSubscriptionPatch	The Data Box Edge/Gateway Edge Profile Subscription patch.
EtcdInfo	Etcd configuration. Variables are only populated by the server, and will be ignored when sending a request.
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.
GenerateCertResponse	Used in activation key generation flow.
ImageRepositoryCredential	Image repository credential. All required parameters must be populated in order to send to Azure.
IoTAddon	IoT Addon. 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.
IoTDeviceInfo	Metadata of IoT device/IoT Edge device to be configured. All required parameters must be populated in order to send to Azure.
IoTEdgeAgentInfo	IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. 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.
KubernetesClusterInfo	Kubernetes cluster configuration. 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.
KubernetesIPConfiguration	Kubernetes node IP configuration. Variables are only populated by the server, and will be ignored when sending a request.
KubernetesRole	Kubernetes 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.
KubernetesRoleCompute	Kubernetes role compute resource. 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.
KubernetesRoleNetwork	Kubernetes role network resource. Variables are only populated by the server, and will be ignored when sending a request.
KubernetesRoleResources	Kubernetes role resources. 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.
KubernetesRoleStorage	Kubernetes role storage resource. Variables are only populated by the server, and will be ignored when sending a request.
KubernetesRoleStorageClassInfo	Kubernetes storage class info. Variables are only populated by the server, and will be ignored when sending a request.
LoadBalancerConfig	Load balancer configuration. Variables are only populated by the server, and will be ignored when sending a request.
MECRole	MEC 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.
MetricConfiguration	Metric configuration. All required parameters must be populated in order to send to Azure.
MetricCounter	The metric counter. All required parameters must be populated in order to send to Azure.
MetricCounterSet	The metric counter set. All required parameters must be populated in order to send to Azure.
MetricDimension	The metric dimension. All required parameters must be populated in order to send to Azure.
MetricDimensionV1	Metric Dimension v1.
MetricSpecificationV1	Metric specification version 1.
MonitoringMetricConfiguration	The metric setting details for the 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.
MonitoringMetricConfigurationList	Collection of metric configurations. Variables are only populated by the server, and will be ignored when sending a request.
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.
Node	Represents a single node in a Data box Edge/Gateway device Gateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node Multi-node Edge devices will have more than 1 nodes. Variables are only populated by the server, and will be ignored when sending a request. ivar id: The path ID that uniquely identifies the object. vartype id: str ivar name: The object name. vartype name: str ivar type: The hierarchical type of the object. vartype type: str ivar node_status: The current status of the individual node. Possible values include: "Unknown", "Up", "Down", "Rebooting", "ShuttingDown". vartype node_status: str or ~azure.mgmt.databoxedge.v2020_09_01.models.NodeStatus ivar node_chassis_serial_number: Serial number of the Chassis. vartype node_chassis_serial_number: str ivar node_serial_number: Serial number of the individual node. vartype node_serial_number: str ivar node_display_name: Display Name of the individual node. vartype node_display_name: str ivar node_friendly_software_version: Friendly software version name that is currently installed on the node. vartype node_friendly_software_version: str ivar node_hcs_version: HCS version that is currently installed on the node. vartype node_hcs_version: str ivar node_instance_id: Guid instance id of the node. vartype node_instance_id: str
NodeInfo	Kubernetes node info. Variables are only populated by the server, and will be ignored when sending a request.
NodeList	Collection of Nodes. Variables are only populated by the server, and will be ignored when sending a request.
Operation	Operations.
OperationDisplay	Operation display properties.
OperationsList	The list of operations used for the discovery of available provider operations. All required parameters must be populated in order to send to Azure.
Order	The order details. Variables are only populated by the server, and will be ignored when sending a request.
OrderList	List of order entities. Variables are only populated by the server, and will be ignored when sending a request.
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 or container.
ResourceIdentity	Msi identity details of the resource. Variables are only populated by the server, and will be ignored when sending a request.
ResourceMoveDetails	Fields for tracking resource move.
ResourceTypeSku	Resource type Sku object. Variables are only populated by the server, and will be ignored when sending a request.
Role	Compute role. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CloudEdgeManagementRole, IoTRole, KubernetesRole, MECRole. 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.
RoleList	Collection of all the roles on the Data Box Edge device. Variables are only populated by the server, and will be ignored when sending a request.
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.
ShareList	Collection of all the shares on the Data Box Edge/Gateway device. Variables are only populated by the server, and will be ignored when sending a request.
Sku	The SKU type.
SkuCost	The metadata for retrieving price info. Variables are only populated by the server, and will be ignored when sending a request.
SkuInformation	Sku information. Variables are only populated by the server, and will be ignored when sending a request.
SkuInformationList	List of SKU Information objects. Variables are only populated by the server, and will be ignored when sending a request.
SkuLocationInfo	The location info. Variables are only populated by the server, and will be ignored when sending a request.
StorageAccount	Represents a Storage Account 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.
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.
StorageAccountCredentialList	The collection of storage account credentials. Variables are only populated by the server, and will be ignored when sending a request.
StorageAccountList	Collection of all the Storage Accounts on the Data Box Edge/Gateway device. Variables are only populated by the server, and will be ignored when sending a request.
SubscriptionRegisteredFeatures	SubscriptionRegisteredFeatures.
SymmetricKey	Symmetric key for authentication.
SystemData	Metadata pertaining to creation and last modification of the resource.
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.
TriggerList	Collection of all trigger on the data box edge device. Variables are only populated by the server, and will be ignored when sending a request.
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. Variables are only populated by the server, and will be ignored when sending a request.
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.
UserList	Collection of users. Variables are only populated by the server, and will be ignored when sending a request.

Enums

AccountType	Type of storage accessed on the storage account.
AddonState	Addon Provisioning State
AddonType	Addon type.
AlertSeverity	Severity of the alert.
AuthenticationType	The authentication type.
AzureContainerDataFormat	Storage format used for the file represented by the share.
ClientPermissionType	Type of access to be allowed for the client.
ContainerStatus	Current status of the container.
CreatedByType	The type of identity that created the resource.
DataBoxEdgeDeviceKind	The etag for the devices.
DataBoxEdgeDeviceStatus	The status of the Data Box Edge/Gateway device.
DataPolicy	Data policy of the share.
DayOfWeek	An enumeration.
DeviceType	The type of the Data Box Edge/Gateway device.
DownloadPhase	The download phase.
EncryptionAlgorithm	The algorithm used to encrypt "Value".
HostPlatformType	Platform where the runtime is hosted.
InstallRebootBehavior	Indicates if updates are available and at least one of the updates needs a reboot.
JobStatus	The current status of the job.
JobType	The type of the job.
KubernetesNodeType	Node type - Master/Worker
KubernetesState	State of Kubernetes deployment
MetricAggregationType	Metric aggregation type.
MetricCategory	Metric category.
MetricUnit	Metric units.
MonitoringStatus	Current monitoring status of the share.
MountType	Mounting type.
MsiIdentityType	Identity type
NetworkAdapterDHCPStatus	Value indicating whether this adapter has DHCP enabled.
NetworkAdapterRDMAStatus	Value indicating whether this adapter is RDMA capable.
NetworkAdapterStatus	Value indicating whether this adapter is valid.
NetworkGroup	The network group.
NodeStatus	The current status of the individual node
OrderState	Status of the order as per the allowed status types.
PlatformType	Host OS supported by the Arc addon.
PosixComplianceStatus	If provisioned storage is posix compliant.
ResourceMoveStatus	Denotes whether move operation is in progress
RoleStatus	Local Edge Management Status
RoleTypes	An enumeration.
SSLStatus	Signifies whether SSL needs to be enabled or not.
ShareAccessProtocol	Access protocol to be used by the share.
ShareAccessType	Type of access to be allowed on the share for this user.
ShareStatus	Current status of the share.
ShipmentType	An enumeration.
SkuAvailability	Links to the next set of results
SkuName	The Sku name.
SkuSignupOption	Sku can be signed up by customer or not.
SkuTier	The Sku tier.
SkuVersion	Availability of the Sku as preview/stable.
StorageAccountStatus	Current status of the storage account
SubscriptionState	An enumeration.
TimeGrain	An enumeration.
TriggerEventType	Trigger Kind.
UpdateOperation	The current update operation.
UpdateOperationStage	Current stage of the update operation.
UserType	Type of the user.