azure.mgmt.edgegateway.models module

class azure.mgmt.edgegateway.models.Address(*, address_line1: str, postal_code: str, city: str, state: str, country: str, address_line2: str = None, address_line3: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The shipping address of the customer.

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

Parameters

  • address_line1 (str) – Required. The address line1.

  • address_line2 (str) – The address line2.

  • address_line3 (str) – The address line3.

  • postal_code (str) – Required. The postal code.

  • city (str) – Required. The city name.

  • state (str) – Required. The state name.

  • country (str) – Required. The country name.

class azure.mgmt.edgegateway.models.AlertErrorDetails(**kwargs)[source]

Bases: msrest.serialization.Model

Error details for the alert.

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

Variables

  • error_code (str) – Error code.

  • error_message (str) – Error Message.

  • occurrences (int) – Number of occurrences.

class azure.mgmt.edgegateway.models.Alert(**kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

Alert on the data box edge/gateway device.

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

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • title (str) – Alert title.

  • alert_type (str) – Alert type.

  • appeared_at_date_time (datetime) – UTC time when the alert appeared.

  • recommendation (str) – Alert recommendation.

  • severity (str or AlertSeverity) – Severity of the alert. Possible values include: ‘Informational’, ‘Warning’, ‘Critical’

  • error_details (AlertErrorDetails) – Error details of the alert.

  • detailed_information (dict[str, str]) – Alert details.

class azure.mgmt.edgegateway.models.ARMBaseModel(**kwargs)[source]

Bases: msrest.serialization.Model

Represents the base class for all object models.

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

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

class azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret(*, value: str, encryption_algorithm, encryption_cert_thumbprint: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represent the secrets intended for encryption with asymmetric key pair.

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

Parameters

  • value (str) – Required. The value of the secret.

  • encryption_cert_thumbprint (str) – Thumbprint certificate used to encrypt “Value”. If the value is unencrypted, it will be null.

  • encryption_algorithm (str or EncryptionAlgorithm) – Required. The algorithm used to encrypt “Value”. Possible values include: ‘None’, ‘AES256’, ‘RSAES_PKCS1_v_1_5’

class azure.mgmt.edgegateway.models.SymmetricKey(*, connection_string=None, **kwargs)[source]

Bases: msrest.serialization.Model

Symmetric key for authentication.

Parameters

connection_string (AsymmetricEncryptedSecret) – Connection string based on the symmetric key.

class azure.mgmt.edgegateway.models.Authentication(*, symmetric_key=None, **kwargs)[source]

Bases: msrest.serialization.Model

Authentication mechanism for IoT devices.

Parameters

symmetric_key (SymmetricKey) – Symmetric key for authentication.

class azure.mgmt.edgegateway.models.AzureContainerInfo(*, storage_account_credential_id: str, container_name: str, data_format, **kwargs)[source]

Bases: msrest.serialization.Model

Azure container mapping of the endpoint.

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

Parameters

  • storage_account_credential_id (str) – Required. ID of the storage account credential used to access storage.

  • container_name (str) – Required. Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).

  • data_format (str or AzureContainerDataFormat) – Required. Storage format used for the file represented by the share. Possible values include: ‘BlockBlob’, ‘PageBlob’, ‘AzureFile’

class azure.mgmt.edgegateway.models.BandwidthSchedule(*, start: str, stop: str, rate_in_mbps: int, days, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

  • start (str) – Required. The start time of the schedule in UTC.

  • stop (str) – Required. The stop time of the schedule in UTC.

  • rate_in_mbps (int) – Required. The bandwidth rate in Mbps.

  • days (list[str or DayOfWeek]) – Required. The days of the week when this schedule is applicable.

class azure.mgmt.edgegateway.models.ClientAccessRight(*, client: str, access_permission, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

  • client (str) – Required. IP of the client.

  • access_permission (str or ClientPermissionType) – Required. Type of access to be allowed for the client. Possible values include: ‘NoAccess’, ‘ReadOnly’, ‘ReadWrite’

class azure.mgmt.edgegateway.models.ContactDetails(*, contact_person: str, company_name: str, phone: str, email_list, **kwargs)[source]

Bases: msrest.serialization.Model

Contains all the contact details of the customer.

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

Parameters

  • contact_person (str) – Required. The contact person name.

  • company_name (str) – Required. The name of the company.

  • phone (str) – Required. The phone number.

  • email_list (list[str]) – Required. The email list.

class azure.mgmt.edgegateway.models.Sku(*, name=None, tier=None, **kwargs)[source]

Bases: msrest.serialization.Model

The SKU type.

Parameters

  • name (str or SkuName) – SKU name. Possible values include: ‘Gateway’, ‘Edge’

  • tier (str or SkuTier) – The SKU tier. This is based on the SKU name. Possible values include: ‘Standard’

class azure.mgmt.edgegateway.models.DataBoxEdgeDevice(*, location: str, tags=None, sku=None, etag: str = None, data_box_edge_device_status=None, description: str = None, model_description: str = None, friendly_name: str = None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • serial_number (str) – The Serial Number of Data Box Edge/Gateway device.

  • device_type (str or DeviceType) – The type of the Data Box Edge/Gateway device. Possible values include: ‘DataBoxEdgeDevice’

  • culture (str) – The Data Box Edge/Gateway device culture.

  • device_model (str) – The Data Box Edge/Gateway device model.

  • device_software_version (str) – The Data Box Edge/Gateway device software version.

  • device_local_capacity (long) – The Data Box Edge/Gateway device local capacity in MB.

  • time_zone (str) – The Data Box Edge/Gateway device timezone.

  • device_hcs_version (str) – The device software version number of the device (eg: 1.2.18105.6).

  • configured_role_types (list[str or RoleTypes]) – Type of compute roles configured.

Parameters

  • location (str) – Required. 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.

  • tags (dict[str, str]) – The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

  • sku (Sku) – The SKU type.

  • etag (str) – The etag for the devices.

  • data_box_edge_device_status (str or DataBoxEdgeDeviceStatus) – The status of the Data Box Edge/Gateway device. Possible values include: ‘ReadyToSetup’, ‘Online’, ‘Offline’, ‘NeedsAttention’, ‘Disconnected’, ‘PartiallyDisconnected’

  • description (str) – The Description of the Data Box Edge/Gateway device.

  • model_description (str) – The description of the Data Box Edge/Gateway device model.

  • friendly_name (str) – The Data Box Edge/Gateway device name.

class azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo(*, encryption_key_thumbprint: str = None, encryption_key: str = None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • resource_key (str) – The Resource ID of the Resource.

Parameters

  • encryption_key_thumbprint (str) – The digital signature of encrypted certificate.

  • encryption_key (str) – The public part of the encryption certificate. Client uses this to encrypt any secret.

class azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The Data Box Edge/Gateway device patch.

Parameters

tags (dict[str, str]) – The tags attached to the Data Box Edge/Gateway resource.

class azure.mgmt.edgegateway.models.FileSourceInfo(*, share_id: str, **kwargs)[source]

Bases: msrest.serialization.Model

File source details.

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

Parameters

share_id (str) – Required. File share ID.

class azure.mgmt.edgegateway.models.RoleSinkInfo(*, role_id: str, **kwargs)[source]

Bases: msrest.serialization.Model

Compute role against which events will be raised.

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

Parameters

role_id (str) – Required. Compute role ID.

class azure.mgmt.edgegateway.models.FileEventTrigger(*, source_info, sink_info, custom_context_tag: str = None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.trigger_py3.Trigger

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

  • kind (str) – Required. Constant filled by server.

  • source_info (FileSourceInfo) – Required. File event source details.

  • sink_info (RoleSinkInfo) – Required. Role sink info.

  • custom_context_tag (str) – 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.

class azure.mgmt.edgegateway.models.IoTDeviceInfo(*, device_id: str, io_thost_hub: str, authentication=None, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters

  • device_id (str) – Required. ID of the IoT device/edge device.

  • io_thost_hub (str) – Required. Host name for the IoT hub associated to the device.

  • authentication (Authentication) – IoT device authentication info.

class azure.mgmt.edgegateway.models.MountPointMap(*, share_id: str, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

share_id (str) – Required. ID of the share mounted to the role VM.

Variables

  • role_id (str) – ID of the role to which share is mounted.

  • mount_point (str) – Mount point for the share.

  • role_type (str or RoleTypes) – Role type. Possible values include: ‘IOT’, ‘ASA’, ‘Functions’, ‘Cognitive’

class azure.mgmt.edgegateway.models.IoTRole(*, host_platform, io_tdevice_details, io_tedge_device_details, role_status, share_mappings=None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.role_py3.Role

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

  • kind (str) – Required. Constant filled by server.

  • host_platform (str or PlatformType) – Required. Host OS supported by the IoT role. Possible values include: ‘Windows’, ‘Linux’

  • io_tdevice_details (IoTDeviceInfo) – Required. IoT device metadata to which data box edge device needs to be connected.

  • io_tedge_device_details (IoTDeviceInfo) – Required. IoT edge device to which the IoT role needs to be configured.

  • share_mappings (list[MountPointMap]) – Mount points of shares in role(s).

  • role_status (str or RoleStatus) – Required. Role status. Possible values include: ‘Enabled’, ‘Disabled’

class azure.mgmt.edgegateway.models.Ipv4Config(**kwargs)[source]

Bases: msrest.serialization.Model

Details related to the IPv4 address configuration.

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

Variables

  • ip_address (str) – The IPv4 address of the network adapter.

  • subnet (str) – The IPv4 subnet of the network adapter.

  • gateway (str) – The IPv4 gateway of the network adapter.

class azure.mgmt.edgegateway.models.Ipv6Config(**kwargs)[source]

Bases: msrest.serialization.Model

Details related to the IPv6 address configuration.

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

Variables

  • ip_address (str) – The IPv6 address of the network adapter.

  • prefix_length (int) – The IPv6 prefix of the network adapter.

  • gateway (str) – The IPv6 gateway of the network adapter.

class azure.mgmt.edgegateway.models.JobErrorItem(**kwargs)[source]

Bases: msrest.serialization.Model

The job error items.

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

Variables

  • recommendations (list[str]) – The recommended actions.

  • code (str) – The code intended for programmatic access.

  • message (str) – The message that describes the error in detail.

class azure.mgmt.edgegateway.models.JobErrorDetails(**kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

  • error_details (list[JobErrorItem]) – The error details.

  • code (str) – The code intended for programmatic access.

  • message (str) – The message that describes the error in detail.

class azure.mgmt.edgegateway.models.UpdateDownloadProgress(**kwargs)[source]

Bases: msrest.serialization.Model

Details about the download progress of update.

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

Variables

  • download_phase (str or DownloadPhase) – The download phase. Possible values include: ‘Unknown’, ‘Initializing’, ‘Downloading’, ‘Verifying’

  • percent_complete (int) – Percentage of completion.

  • total_bytes_to_download (float) – Total bytes to download.

  • total_bytes_downloaded (float) – Total bytes downloaded.

  • number_of_updates_to_download (int) – Number of updates to download.

  • number_of_updates_downloaded (int) – Number of updates downloaded.

class azure.mgmt.edgegateway.models.UpdateInstallProgress(**kwargs)[source]

Bases: msrest.serialization.Model

Progress details during installation of updates.

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

Variables

  • percent_complete (int) – Percentage completed.

  • number_of_updates_to_install (int) – Number of updates to install.

  • number_of_updates_installed (int) – Number of updates installed.

class azure.mgmt.edgegateway.models.Job(*, folder: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A device job.

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

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The name of the object.

  • type (str) – The hierarchical type of the object.

  • status (str or JobStatus) – The current status of the job. Possible values include: ‘Invalid’, ‘Running’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Paused’, ‘Scheduled’

  • start_time (datetime) – The UTC date and time at which the job started.

  • end_time (datetime) – The UTC date and time at which the job completed.

  • percent_complete (int) – The percentage of the job that is complete.

  • error (JobErrorDetails) – The error details.

  • job_type (str or JobType) – The type of the job. Possible values include: ‘Invalid’, ‘ScanForUpdates’, ‘DownloadUpdates’, ‘InstallUpdates’, ‘RefreshShare’

  • current_stage (str or UpdateOperationStage) – Current stage of the update operation. Possible values include: ‘Unknown’, ‘Initial’, ‘ScanStarted’, ‘ScanComplete’, ‘ScanFailed’, ‘DownloadStarted’, ‘DownloadComplete’, ‘DownloadFailed’, ‘InstallStarted’, ‘InstallComplete’, ‘InstallFailed’, ‘RebootInitiated’, ‘Success’, ‘Failure’, ‘RescanStarted’, ‘RescanComplete’, ‘RescanFailed’

  • download_progress (UpdateDownloadProgress) – The download progress.

  • install_progress (UpdateInstallProgress) – The install progress.

  • total_refresh_errors (int) – Total number of errors encountered during the refresh process.

  • error_manifest_file (str) – Local share/remote container relative path to the error manifest file of the refresh.

  • share_id (str) – ARM ID of the share that was refreshed.

Parameters

folder (str) – If only subfolders need to be refreshed, then the subfolder path inside the share. (The path is empty if there are no subfolders.)

class azure.mgmt.edgegateway.models.MetricDimensionV1(*, name: str = None, display_name: str = None, to_be_exported_for_shoebox: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Metric Dimension v1.

Parameters

  • name (str) – Name of the metrics dimension.

  • display_name (str) – Display name of the metrics dimension.

  • to_be_exported_for_shoebox (bool) – To be exported to shoe box.

class azure.mgmt.edgegateway.models.MetricSpecificationV1(*, name: str = None, display_name: str = None, display_description: str = None, unit=None, aggregation_type=None, dimensions=None, fill_gap_with_zero: bool = None, category=None, resource_id_dimension_name_override: str = None, supported_time_grain_types=None, supported_aggregation_types=None, **kwargs)[source]

Bases: msrest.serialization.Model

Metric specification version 1.

Parameters

  • name (str) – Name of the metric.

  • display_name (str) – Display name of the metric.

  • display_description (str) – Description of the metric to be displayed.

  • unit (str or MetricUnit) – Metric units. Possible values include: ‘NotSpecified’, ‘Percent’, ‘Count’, ‘Seconds’, ‘Milliseconds’, ‘Bytes’, ‘BytesPerSecond’, ‘CountPerSecond’

  • aggregation_type (str or MetricAggregationType) – Metric aggregation type. Possible values include: ‘NotSpecified’, ‘None’, ‘Average’, ‘Minimum’, ‘Maximum’, ‘Total’, ‘Count’

  • dimensions (list[MetricDimensionV1]) – Metric dimensions, other than default dimension which is resource.

  • fill_gap_with_zero (bool) – Set true to fill the gaps with zero.

  • category (str or MetricCategory) – Metric category. Possible values include: ‘Capacity’, ‘Transaction’

  • resource_id_dimension_name_override (str) – Resource name override.

  • supported_time_grain_types (list[str or TimeGrain]) – Support granularity of metrics.

  • supported_aggregation_types (list[str or MetricAggregationType]) – Support metric aggregation type.

class azure.mgmt.edgegateway.models.NetworkAdapterPosition(**kwargs)[source]

Bases: msrest.serialization.Model

The network adapter position.

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

Variables

  • network_group (str or NetworkGroup) – The network group. Possible values include: ‘None’, ‘NonRDMA’, ‘RDMA’

  • port (int) – The port.

class azure.mgmt.edgegateway.models.NetworkAdapter(*, rdma_status=None, dhcp_status=None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents the networkAdapter on a device.

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

Variables

  • adapter_id (str) – Instance ID of network adapter.

  • adapter_position (NetworkAdapterPosition) – Hardware position of network adapter.

  • index (int) – Logical index of the adapter.

  • node_id (str) – Node ID of the network adapter.

  • network_adapter_name (str) – Network adapter name.

  • label (str) – Hardware label for the adapter.

  • mac_address (str) – MAC address.

  • link_speed (long) – Link speed.

  • status (str or NetworkAdapterStatus) – Value indicating whether this adapter is valid. Possible values include: ‘Inactive’, ‘Active’

  • ipv4_configuration (Ipv4Config) – The IPv4 configuration of the network adapter.

  • ipv6_configuration (Ipv6Config) – The IPv6 configuration of the network adapter.

  • ipv6_link_local_address (str) – The IPv6 local address.

  • dns_servers (list[str]) – The list of DNS Servers of the device.

Parameters

  • rdma_status (str or NetworkAdapterRDMAStatus) – Value indicating whether this adapter is RDMA capable. Possible values include: ‘Incapable’, ‘Capable’

  • dhcp_status (str or NetworkAdapterDHCPStatus) – Value indicating whether this adapter has DHCP enabled. Possible values include: ‘Disabled’, ‘Enabled’

class azure.mgmt.edgegateway.models.NetworkSettings(**kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

The network settings of a device.

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

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • network_adapters (list[NetworkAdapter]) – The network adapter list on the device.

class azure.mgmt.edgegateway.models.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Operation display properties.

Parameters

  • provider (str) – Provider name.

  • resource (str) – The type of resource in which the operation is performed.

  • operation (str) – Operation to be performed on the resource.

  • description (str) – Description of the operation to be performed.

class azure.mgmt.edgegateway.models.ServiceSpecification(*, metric_specifications=None, **kwargs)[source]

Bases: msrest.serialization.Model

Service specification.

Parameters

metric_specifications (list[MetricSpecificationV1]) – Metric specification as defined by shoebox.

class azure.mgmt.edgegateway.models.Operation(*, name: str = None, display=None, origin: str = None, service_specification=None, **kwargs)[source]

Bases: msrest.serialization.Model

Operations.

Parameters

  • name (str) – Name of the operation.

  • display (OperationDisplay) – Properties displayed for the operation.

  • origin (str) – Origin of the operation.

  • service_specification (ServiceSpecification) – Service specification.

class azure.mgmt.edgegateway.models.OrderStatus(*, status, comments: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

  • status (str or OrderState) – Required. Status of the order as per the allowed status types. Possible values include: ‘Untracked’, ‘AwaitingFulfilment’, ‘AwaitingPreparation’, ‘AwaitingShipment’, ‘Shipped’, ‘Arriving’, ‘Delivered’, ‘ReplacementRequested’, ‘LostDevice’, ‘Declined’, ‘ReturnInitiated’, ‘AwaitingReturnShipment’, ‘ShippedBack’, ‘CollectedAtMicrosoft’

  • comments (str) – Comments related to this status change.

Variables

update_date_time (datetime) – Time of status update.

class azure.mgmt.edgegateway.models.TrackingInfo(*, serial_number: str = None, carrier_name: str = None, tracking_id: str = None, tracking_url: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Tracking courier information.

Parameters

  • serial_number (str) – Serial number of the device being tracked.

  • carrier_name (str) – Name of the carrier used in the delivery.

  • tracking_id (str) – Tracking ID of the shipment.

  • tracking_url (str) – Tracking URL of the shipment.

class azure.mgmt.edgegateway.models.Order(*, contact_information, shipping_address, current_status=None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • order_history (list[OrderStatus]) – List of status changes in the order.

  • serial_number (str) – Serial number of the device.

  • delivery_tracking_info (list[TrackingInfo]) – Tracking information for the package delivered to the customer whether it has an original or a replacement device.

  • return_tracking_info (list[TrackingInfo]) – Tracking information for the package returned from the customer whether it has an original or a replacement device.

Parameters

  • contact_information (ContactDetails) – Required. The contact details.

  • shipping_address (Address) – Required. The shipping address.

  • current_status (OrderStatus) – Current status of the order.

class azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo(*, start_time, schedule: str, topic: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Periodic timer event source.

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

Parameters

  • start_time (datetime) – Required. The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.

  • schedule (str) – Required. Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.

  • topic (str) – Topic where periodic events are published to IoT device.

class azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger(*, source_info, sink_info, custom_context_tag: str = None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.trigger_py3.Trigger

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

  • kind (str) – Required. Constant filled by server.

  • source_info (PeriodicTimerSourceInfo) – Required. Periodic timer details.

  • sink_info (RoleSinkInfo) – Required. Role Sink information.

  • custom_context_tag (str) – 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.

class azure.mgmt.edgegateway.models.RefreshDetails(*, in_progress_refresh_job_id: str = None, last_completed_refresh_job_time_in_utc=None, error_manifest_file: str = None, last_job: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Fields for tracking refresh job on the share.

Parameters

  • in_progress_refresh_job_id (str) – 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.

  • last_completed_refresh_job_time_in_utc (datetime) – 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.

  • error_manifest_file (str) – 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.

  • last_job (str) – Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job.

class azure.mgmt.edgegateway.models.Role(**kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

kind (str) – Required. Constant filled by server.

class azure.mgmt.edgegateway.models.SecuritySettings(*, device_admin_password, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

device_admin_password (AsymmetricEncryptedSecret) – Required. Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters.

class azure.mgmt.edgegateway.models.UserAccessRight(*, user_id: str, access_type, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

  • user_id (str) – Required. User ID (already existing in the device).

  • access_type (str or ShareAccessType) – Required. Type of access to be allowed for the user. Possible values include: ‘Change’, ‘Read’, ‘Custom’

class azure.mgmt.edgegateway.models.Share(*, share_status, monitoring_status, access_protocol, description: str = None, azure_container_info=None, user_access_rights=None, client_access_rights=None, refresh_details=None, data_policy=None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • share_mappings (list[MountPointMap]) – Share mount point to the role.

Parameters

  • description (str) – Description for the share.

  • share_status (str or ShareStatus) – Required. Current status of the share. Possible values include: ‘Online’, ‘Offline’

  • monitoring_status (str or MonitoringStatus) – Required. Current monitoring status of the share. Possible values include: ‘Enabled’, ‘Disabled’

  • azure_container_info (AzureContainerInfo) – Azure container mapping for the share.

  • access_protocol (str or ShareAccessProtocol) – Required. Access protocol to be used by the share. Possible values include: ‘SMB’, ‘NFS’

  • user_access_rights (list[UserAccessRight]) – Mapping of users and corresponding access rights on the share (required for SMB protocol).

  • client_access_rights (list[ClientAccessRight]) – List of IP addresses and corresponding access rights on the share(required for NFS protocol).

  • refresh_details (RefreshDetails) – Details of the refresh job on this share.

  • data_policy (str or DataPolicy) – Data policy of the share. Possible values include: ‘Cloud’, ‘Local’

class azure.mgmt.edgegateway.models.ShareAccessRight(*, share_id: str, access_type, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

  • share_id (str) – Required. The share ID.

  • access_type (str or ShareAccessType) – Required. Type of access to be allowed on the share for this user. Possible values include: ‘Change’, ‘Read’, ‘Custom’

class azure.mgmt.edgegateway.models.StorageAccountCredential(*, alias: str, ssl_status, account_type, user_name: str = None, account_key=None, connection_string: str = None, blob_domain_name: str = None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

  • alias (str) – Required. Alias for the storage account.

  • user_name (str) – Username for the storage account.

  • account_key (AsymmetricEncryptedSecret) – Encrypted storage key.

  • connection_string (str) – Connection string for the storage account. Use this string if username and account key are not specified.

  • ssl_status (str or SSLStatus) – Required. Signifies whether SSL needs to be enabled or not. Possible values include: ‘Enabled’, ‘Disabled’

  • blob_domain_name (str) – Blob end point for private clouds.

  • account_type (str or AccountType) – Required. Type of storage accessed on the storage account. Possible values include: ‘GeneralPurposeStorage’, ‘BlobStorage’

class azure.mgmt.edgegateway.models.Trigger(**kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters

kind (str) – Required. Constant filled by server.

class azure.mgmt.edgegateway.models.UpdateSummary(*, device_version_number: str = None, friendly_device_version_name: str = None, device_last_scanned_date_time=None, last_completed_scan_job_date_time=None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

  • last_completed_download_job_date_time (datetime) – The time when the last Download job was completed (success/cancelled/failed) on the appliance.

  • last_completed_install_job_date_time (datetime) – The time when the last Install job was completed (success/cancelled/failed) on the appliance.

  • total_number_of_updates_available (int) – The number of updates available for the current device version as per the last device scan.

  • total_number_of_updates_pending_download (int) – The total number of items pending download.

  • total_number_of_updates_pending_install (int) – The total number of items pending install.

  • reboot_behavior (str or InstallRebootBehavior) – Indicates if updates are available and at least one of the updates needs a reboot. Possible values include: ‘NeverReboots’, ‘RequiresReboot’, ‘RequestReboot’

  • ongoing_update_operation (str or UpdateOperation) – The current update operation. Possible values include: ‘None’, ‘Scan’, ‘Download’, ‘Install’

  • in_progress_download_job_id (str) – The job ID of the download job in progress.

  • in_progress_install_job_id (str) – The job ID of the install job in progress.

  • in_progress_download_job_started_date_time (datetime) – The time when the currently running download (if any) started.

  • in_progress_install_job_started_date_time (datetime) – The time when the currently running install (if any) started.

  • update_titles (list[str]) – The list of updates available for install.

  • total_update_size_in_bytes (float) – The total size of updates available for download in bytes.

Parameters

  • device_version_number (str) – The current version of the device in format: 1.2.17312.13.”,

  • friendly_device_version_name (str) – The current version of the device in text format.

  • device_last_scanned_date_time (datetime) – The last time when a scan was done on the device.

  • last_completed_scan_job_date_time (datetime) – The time when the last scan job was completed (success/cancelled/failed) on the appliance.

class azure.mgmt.edgegateway.models.UploadCertificateRequest(*, certificate: str, authentication_type=None, **kwargs)[source]

Bases: msrest.serialization.Model

The upload certificate request.

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

Parameters

  • authentication_type (str or AuthenticationType) – The authentication type. Possible values include: ‘Invalid’, ‘AzureActiveDirectory’

  • certificate (str) – Required. The base64 encoded certificate raw data.

class azure.mgmt.edgegateway.models.UploadCertificateResponse(*, resource_id: str, aad_authority: str, aad_tenant_id: str, service_principal_client_id: str, service_principal_object_id: str, azure_management_endpoint_audience: str, auth_type=None, **kwargs)[source]

Bases: msrest.serialization.Model

The upload registration certificate response.

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

Parameters

  • auth_type (str or AuthenticationType) – Specifies authentication type. Possible values include: ‘Invalid’, ‘AzureActiveDirectory’

  • resource_id (str) – Required. The resource ID of the Data Box Edge/Gateway device.

  • aad_authority (str) – Required. Azure Active Directory tenant authority.

  • aad_tenant_id (str) – Required. Azure Active Directory tenant ID.

  • service_principal_client_id (str) – Required. Azure Active Directory service principal client ID.

  • service_principal_object_id (str) – Required. Azure Active Directory service principal object ID.

  • azure_management_endpoint_audience (str) – Required. The azure management endpoint audience.

class azure.mgmt.edgegateway.models.User(*, encrypted_password=None, share_access_rights=None, **kwargs)[source]

Bases: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel

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.

Variables

  • id (str) – The path ID that uniquely identifies the object.

  • name (str) – The object name.

  • type (str) – The hierarchical type of the object.

Parameters
class azure.mgmt.edgegateway.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataBoxEdgeDevice object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.AlertPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Alert object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.BandwidthSchedulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BandwidthSchedule object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.OrderPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Order object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.RolePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Role object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.SharePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Share object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.StorageAccountCredentialPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of StorageAccountCredential object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.TriggerPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Trigger object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.UserPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of User object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.edgegateway.models.AlertSeverity[source]

Bases: str, enum.Enum

An enumeration.

critical = 'Critical'
informational = 'Informational'
warning = 'Warning'
class azure.mgmt.edgegateway.models.EncryptionAlgorithm[source]

Bases: str, enum.Enum

An enumeration.

aes256 = 'AES256'
none = 'None'
rsaes_pkcs1_v_1_5 = 'RSAES_PKCS1_v_1_5'
class azure.mgmt.edgegateway.models.AzureContainerDataFormat[source]

Bases: str, enum.Enum

An enumeration.

azure_file = 'AzureFile'
block_blob = 'BlockBlob'
page_blob = 'PageBlob'
class azure.mgmt.edgegateway.models.DayOfWeek[source]

Bases: str, enum.Enum

An enumeration.

friday = 'Friday'
monday = 'Monday'
saturday = 'Saturday'
sunday = 'Sunday'
thursday = 'Thursday'
tuesday = 'Tuesday'
wednesday = 'Wednesday'
class azure.mgmt.edgegateway.models.ClientPermissionType[source]

Bases: str, enum.Enum

An enumeration.

no_access = 'NoAccess'
read_only = 'ReadOnly'
read_write = 'ReadWrite'
class azure.mgmt.edgegateway.models.SkuName[source]

Bases: str, enum.Enum

An enumeration.

edge = 'Edge'
gateway = 'Gateway'
class azure.mgmt.edgegateway.models.SkuTier[source]

Bases: str, enum.Enum

An enumeration.

standard = 'Standard'
class azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus[source]

Bases: str, enum.Enum

An enumeration.

disconnected = 'Disconnected'
needs_attention = 'NeedsAttention'
offline = 'Offline'
online = 'Online'
partially_disconnected = 'PartiallyDisconnected'
ready_to_setup = 'ReadyToSetup'
class azure.mgmt.edgegateway.models.DeviceType[source]

Bases: str, enum.Enum

An enumeration.

data_box_edge_device = 'DataBoxEdgeDevice'
class azure.mgmt.edgegateway.models.RoleTypes[source]

Bases: str, enum.Enum

An enumeration.

asa = 'ASA'
cognitive = 'Cognitive'
functions = 'Functions'
iot = 'IOT'
class azure.mgmt.edgegateway.models.PlatformType[source]

Bases: str, enum.Enum

An enumeration.

linux = 'Linux'
windows = 'Windows'
class azure.mgmt.edgegateway.models.RoleStatus[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.edgegateway.models.JobStatus[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
failed = 'Failed'
invalid = 'Invalid'
paused = 'Paused'
running = 'Running'
scheduled = 'Scheduled'
succeeded = 'Succeeded'
class azure.mgmt.edgegateway.models.JobType[source]

Bases: str, enum.Enum

An enumeration.

download_updates = 'DownloadUpdates'
install_updates = 'InstallUpdates'
invalid = 'Invalid'
refresh_share = 'RefreshShare'
scan_for_updates = 'ScanForUpdates'
class azure.mgmt.edgegateway.models.UpdateOperationStage[source]

Bases: str, enum.Enum

An enumeration.

download_complete = 'DownloadComplete'
download_failed = 'DownloadFailed'
download_started = 'DownloadStarted'
failure = 'Failure'
initial = 'Initial'
install_complete = 'InstallComplete'
install_failed = 'InstallFailed'
install_started = 'InstallStarted'
reboot_initiated = 'RebootInitiated'
rescan_complete = 'RescanComplete'
rescan_failed = 'RescanFailed'
rescan_started = 'RescanStarted'
scan_complete = 'ScanComplete'
scan_failed = 'ScanFailed'
scan_started = 'ScanStarted'
success = 'Success'
unknown = 'Unknown'
class azure.mgmt.edgegateway.models.DownloadPhase[source]

Bases: str, enum.Enum

An enumeration.

downloading = 'Downloading'
initializing = 'Initializing'
unknown = 'Unknown'
verifying = 'Verifying'
class azure.mgmt.edgegateway.models.MetricUnit[source]

Bases: str, enum.Enum

An enumeration.

bytes = 'Bytes'
bytes_per_second = 'BytesPerSecond'
count = 'Count'
count_per_second = 'CountPerSecond'
milliseconds = 'Milliseconds'
not_specified = 'NotSpecified'
percent = 'Percent'
seconds = 'Seconds'
class azure.mgmt.edgegateway.models.MetricAggregationType[source]

Bases: str, enum.Enum

An enumeration.

average = 'Average'
count = 'Count'
maximum = 'Maximum'
minimum = 'Minimum'
none = 'None'
not_specified = 'NotSpecified'
total = 'Total'
class azure.mgmt.edgegateway.models.MetricCategory[source]

Bases: str, enum.Enum

An enumeration.

capacity = 'Capacity'
transaction = 'Transaction'
class azure.mgmt.edgegateway.models.TimeGrain[source]

Bases: str, enum.Enum

An enumeration.

pt12_h = 'PT12H'
pt15_m = 'PT15M'
pt1_d = 'PT1D'
pt1_h = 'PT1H'
pt1_m = 'PT1M'
pt30_m = 'PT30M'
pt5_m = 'PT5M'
pt6_h = 'PT6H'
class azure.mgmt.edgegateway.models.NetworkGroup[source]

Bases: str, enum.Enum

An enumeration.

non_rdma = 'NonRDMA'
none = 'None'
rdma = 'RDMA'
class azure.mgmt.edgegateway.models.NetworkAdapterStatus[source]

Bases: str, enum.Enum

An enumeration.

active = 'Active'
inactive = 'Inactive'
class azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus[source]

Bases: str, enum.Enum

An enumeration.

capable = 'Capable'
incapable = 'Incapable'
class azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.edgegateway.models.OrderState[source]

Bases: str, enum.Enum

An enumeration.

arriving = 'Arriving'
awaiting_fulfilment = 'AwaitingFulfilment'
awaiting_preparation = 'AwaitingPreparation'
awaiting_return_shipment = 'AwaitingReturnShipment'
awaiting_shipment = 'AwaitingShipment'
collected_at_microsoft = 'CollectedAtMicrosoft'
declined = 'Declined'
delivered = 'Delivered'
lost_device = 'LostDevice'
replacement_requested = 'ReplacementRequested'
return_initiated = 'ReturnInitiated'
shipped = 'Shipped'
shipped_back = 'ShippedBack'
untracked = 'Untracked'
class azure.mgmt.edgegateway.models.AuthenticationType[source]

Bases: str, enum.Enum

An enumeration.

azure_active_directory = 'AzureActiveDirectory'
invalid = 'Invalid'
class azure.mgmt.edgegateway.models.ShareStatus[source]

Bases: str, enum.Enum

An enumeration.

offline = 'Offline'
online = 'Online'
class azure.mgmt.edgegateway.models.MonitoringStatus[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.edgegateway.models.ShareAccessProtocol[source]

Bases: str, enum.Enum

An enumeration.

nfs = 'NFS'
smb = 'SMB'
class azure.mgmt.edgegateway.models.ShareAccessType[source]

Bases: str, enum.Enum

An enumeration.

change = 'Change'
custom = 'Custom'
read = 'Read'
class azure.mgmt.edgegateway.models.DataPolicy[source]

Bases: str, enum.Enum

An enumeration.

cloud = 'Cloud'
local = 'Local'
class azure.mgmt.edgegateway.models.SSLStatus[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.edgegateway.models.AccountType[source]

Bases: str, enum.Enum

An enumeration.

blob_storage = 'BlobStorage'
general_purpose_storage = 'GeneralPurposeStorage'
class azure.mgmt.edgegateway.models.InstallRebootBehavior[source]

Bases: str, enum.Enum

An enumeration.

never_reboots = 'NeverReboots'
request_reboot = 'RequestReboot'
requires_reboot = 'RequiresReboot'
class azure.mgmt.edgegateway.models.UpdateOperation[source]

Bases: str, enum.Enum

An enumeration.

download = 'Download'
install = 'Install'
none = 'None'
scan = 'Scan'