@azure/arm-databoxedge package

Classes

DataBoxEdgeManagementClient

Interfaces

ARMBaseModel	Represents the base class for all object models.
Addon	Role Addon
AddonsCreateOrUpdateOptionalParams	Optional parameters.
AddonsDeleteOptionalParams	Optional parameters.
AddonsGetOptionalParams	Optional parameters.
AddonsListByRoleOptionalParams	Optional parameters.
AddonsOperations	Interface representing a Addons operations.
Address	The shipping address of the customer.
Alert	Alert on the data box edge/gateway device.
AlertErrorDetails	Error details for the alert.
AlertProperties	Properties of alert.
AlertsGetOptionalParams	Optional parameters.
AlertsListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
AlertsOperations	Interface representing a Alerts operations.
ArcAddon	Arc Addon.
ArcAddonProperties	Arc addon properties.
AsymmetricEncryptedSecret	Represent the secrets intended for encryption with asymmetric key pair.
Authentication	Authentication mechanism for IoT devices.
AvailableSkusListOptionalParams	Optional parameters.
AvailableSkusOperations	Interface representing a AvailableSkus operations.
AzureContainerInfo	Azure container mapping of the endpoint.
BandwidthSchedule	The bandwidth schedule details.
BandwidthScheduleProperties	The properties of the bandwidth schedule.
BandwidthSchedulesCreateOrUpdateOptionalParams	Optional parameters.
BandwidthSchedulesDeleteOptionalParams	Optional parameters.
BandwidthSchedulesGetOptionalParams	Optional parameters.
BandwidthSchedulesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
BandwidthSchedulesOperations	Interface representing a BandwidthSchedules operations.
ClientAccessRight	The mapping between a particular client IP and the type of access client has on the NFS share.
CloudEdgeManagementRole	The preview of Virtual Machine Cloud Management from the Azure supports deploying and managing VMs on your Azure Stack Edge device from Azure Portal. For more information, refer to: https://docs.microsoft.com/en-us/azure/databox-online/azure-stack-edge-gpu-virtual-machine-overview By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/ for additional details.
CloudEdgeManagementRoleProperties	CloudEdgeManagement Role properties.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ClusterCapacityViewData	Cluster Compute Data.
ClusterGpuCapacity	Cluster GPU Data.
ClusterMemoryCapacity	NodeCapacityInfo defines the required information to determine the placement of a VM.
ClusterStorageViewData	Cluster Storage Data.
CniConfig	Cni configuration
ComputeResource	Compute infrastructure Resource
ContactDetails	Contains all the contact details of the customer.
Container	Represents a container on the Data Box Edge/Gateway device.
ContainerProperties	The container properties.
ContainersCreateOrUpdateOptionalParams	Optional parameters.
ContainersDeleteOptionalParams	Optional parameters.
ContainersGetOptionalParams	Optional parameters.
ContainersListByStorageAccountOptionalParams	Optional parameters.
ContainersOperations	Interface representing a Containers operations.
ContainersRefreshOptionalParams	Optional parameters.
DCAccessCode	DC Access code in the case of Self Managed Shipping.
DCAccessCodeProperties	DCAccessCode Properties.
DataBoxEdgeDevice	The Data Box Edge/Gateway device.
DataBoxEdgeDeviceExtendedInfo	The extended Info of the Data Box Edge/Gateway device.
DataBoxEdgeDeviceExtendedInfoPatch	The Data Box Edge/Gateway device extended info patch.
DataBoxEdgeDeviceExtendedInfoProperties	The properties of the Data Box Edge/Gateway device extended info.
DataBoxEdgeDevicePatch	The Data Box Edge/Gateway device patch.
DataBoxEdgeDeviceProperties	The properties of the Data Box Edge/Gateway device.
DataBoxEdgeDevicePropertiesPatch	The Data Box Edge/Gateway device properties patch.
DataBoxEdgeManagementClientOptionalParams	Optional parameters for the client.
DataBoxEdgeSku	The Sku information.
DataResidency	Wraps data-residency related information for edge-resource and this should be used with ARM layer.
DeviceCapacityCheckCheckResourceCreationFeasibilityOptionalParams	Optional parameters.
DeviceCapacityCheckOperations	Interface representing a DeviceCapacityCheck operations.
DeviceCapacityInfo	Object for Capturing DeviceCapacityInfo
DeviceCapacityInfoGetDeviceCapacityInfoOptionalParams	Optional parameters.
DeviceCapacityInfoOperations	Interface representing a DeviceCapacityInfo operations.
DeviceCapacityInfoProperties	The properties of Device Capacity Info
DeviceCapacityRequestInfo	Object for Capturing DeviceCapacityRequestInfo
DeviceCapacityRequestInfoProperties	Properties of Device Capacity Request Info containing VM's to be checked and their corresponding results.
DevicesCreateOrUpdateOptionalParams	Optional parameters.
DevicesCreateOrUpdateSecuritySettingsOptionalParams	Optional parameters.
DevicesDeleteOptionalParams	Optional parameters.
DevicesDownloadUpdatesOptionalParams	Optional parameters.
DevicesGenerateCertificateOptionalParams	Optional parameters.
DevicesGetExtendedInformationOptionalParams	Optional parameters.
DevicesGetNetworkSettingsOptionalParams	Optional parameters.
DevicesGetOptionalParams	Optional parameters.
DevicesGetUpdateSummaryOptionalParams	Optional parameters.
DevicesInstallUpdatesOptionalParams	Optional parameters.
DevicesListByResourceGroupOptionalParams	Optional parameters.
DevicesListBySubscriptionOptionalParams	Optional parameters.
DevicesOperations	Interface representing a Devices operations.
DevicesScanForUpdatesOptionalParams	Optional parameters.
DevicesUpdateExtendedInformationOptionalParams	Optional parameters.
DevicesUpdateOptionalParams	Optional parameters.
DevicesUploadCertificateOptionalParams	Optional parameters.
DiagnosticProactiveLogCollectionSettings	The diagnostic proactive log collection settings of a device.
DiagnosticRemoteSupportSettings	The remote support settings of a device.
DiagnosticRemoteSupportSettingsProperties	The properties of remote support settings.
DiagnosticSettingsGetDiagnosticProactiveLogCollectionSettingsOptionalParams	Optional parameters.
DiagnosticSettingsGetDiagnosticRemoteSupportSettingsOptionalParams	Optional parameters.
DiagnosticSettingsOperations	Interface representing a DiagnosticSettings operations.
DiagnosticSettingsUpdateDiagnosticProactiveLogCollectionSettingsOptionalParams	Optional parameters.
DiagnosticSettingsUpdateDiagnosticRemoteSupportSettingsOptionalParams	Optional parameters.
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
FileEventTrigger	Trigger details.
FileSourceInfo	File source details.
FileTriggerProperties	File trigger properties.
GenerateCertResponse	Used in activation key generation flow.
HostCapacity	Host Capacity Data.
ImageRepositoryCredential	Image repository credential.
IoTAddon	IoT Addon.
IoTAddonProperties	IoT addon properties.
IoTDeviceInfo	Metadata of IoT device/IoT Edge device to be configured.
IoTEdgeAgentInfo	IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.
IoTRole	Compute role.
IoTRoleProperties	IoT role properties.
Ipv4Config	Details related to the IPv4 address configuration.
Ipv6Config	Details related to the IPv6 address configuration.
Job	A device job.
JobErrorDetails	The job error information containing the list of job errors.
JobErrorItem	The job error items.
JobProperties	The properties for the job.
JobsGetOptionalParams	Optional parameters.
JobsOperations	Interface representing a Jobs operations.
KubernetesClusterInfo	Kubernetes cluster configuration
KubernetesIPConfiguration	Kubernetes node IP configuration
KubernetesRole	The limited preview of Kubernetes Cluster Management from the Azure supports: Using a simple turn-key option in Azure Portal, deploy a Kubernetes cluster on your Azure Stack Edge device. Configure Kubernetes cluster running on your device with Arc enabled Kubernetes with a click of a button in the Azure Portal. Azure Arc enables organizations to view, manage, and govern their on-premises Kubernetes clusters using the Azure Portal, command line tools, and APIs. Easily configure Persistent Volumes using SMB and NFS shares for storing container data. For more information, refer to the document here: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8-Cloud-Management-20210323.pdf Or Demo: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8S-Cloud-Management-20210323.mp4 By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/
KubernetesRoleCompute	Kubernetes role compute resource
KubernetesRoleNetwork	Kubernetes role network resource
KubernetesRoleProperties	Kubernetes role properties.
KubernetesRoleResources	Kubernetes role resources
KubernetesRoleStorage	Kubernetes role storage resource
KubernetesRoleStorageClassInfo	Kubernetes storage class info.
LoadBalancerConfig	Load balancer configuration
MECRole	MEC role.
MECRoleProperties	MEC role properties.
MetricConfiguration	Metric configuration.
MetricCounter	The metric counter
MetricCounterSet	The metric counter set
MetricDimension	The metric dimension
MetricDimensionV1	Metric Dimension v1.
MetricSpecificationV1	Metric specification version 1.
MonitoringConfigCreateOrUpdateOptionalParams	Optional parameters.
MonitoringConfigDeleteOptionalParams	Optional parameters.
MonitoringConfigGetOptionalParams	Optional parameters.
MonitoringConfigListOptionalParams	Optional parameters.
MonitoringConfigOperations	Interface representing a MonitoringConfig operations.
MonitoringMetricConfiguration	The metric setting details for the role
MonitoringMetricConfigurationProperties	Metrics properties
MountPointMap	The share mount point.
NetworkAdapter	Represents the networkAdapter on a device.
NetworkAdapterPosition	The network adapter position.
NetworkSettings	The network settings of a device.
NetworkSettingsProperties	The properties of network settings.
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
NodeInfo	Kubernetes node info
NodeProperties	This class represents the nodes in a highly available cluster
NodesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
NodesOperations	Interface representing a Nodes operations.
NumaNodeData	NUMA node data.
Operation	Operations.
OperationDisplay	Operation display properties.
OperationProperties	Operation properties.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OperationsStatusGetOptionalParams	Optional parameters.
OperationsStatusOperations	Interface representing a OperationsStatus operations.
Order	The order details.
OrderProperties	Order properties.
OrderStatus	Represents a single status change.
OrdersCreateOrUpdateOptionalParams	Optional parameters.
OrdersDeleteOptionalParams	Optional parameters.
OrdersGetOptionalParams	Optional parameters.
OrdersListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
OrdersListDCAccessCodeOptionalParams	Optional parameters.
OrdersOperations	Interface representing a Orders operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PeriodicTimerEventTrigger	Trigger details.
PeriodicTimerProperties	Periodic timer trigger properties.
PeriodicTimerSourceInfo	Periodic timer event source.
ProactiveLogCollectionSettingsProperties	The properties of proactive log collection settings.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RawCertificateData	Raw Certificate Data.
RefreshDetails	Fields for tracking refresh job on the share or container.
RemoteSupportSettings	RemoteApplicationType for which remote support settings is being modified
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceIdentity	Msi identity details of the resource
ResourceMoveDetails	Fields for tracking resource move
RestorePollerOptions
Role	Compute role.
RoleSinkInfo	Compute role against which events will be raised.
RolesCreateOrUpdateOptionalParams	Optional parameters.
RolesDeleteOptionalParams	Optional parameters.
RolesGetOptionalParams	Optional parameters.
RolesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
RolesOperations	Interface representing a Roles operations.
Secret	Holds device secret either as a KeyVault reference or as an encrypted value.
SecuritySettings	The security settings of a device.
SecuritySettingsProperties	The properties of security settings.
ServiceSpecification	Service specification.
Share	Represents a share on the Data Box Edge/Gateway device.
ShareAccessRight	Specifies the mapping between this particular user and the type of access he has on shares on this device.
ShareProperties	The share properties.
SharesCreateOrUpdateOptionalParams	Optional parameters.
SharesDeleteOptionalParams	Optional parameters.
SharesGetOptionalParams	Optional parameters.
SharesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
SharesOperations	Interface representing a Shares operations.
SharesRefreshOptionalParams	Optional parameters.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	The SKU type.
SkuCapability	The metadata to describe the capability.
SkuCost	The metadata for retrieving price info.
SkuLocationInfo	The location info.
StorageAccount	Represents a Storage Account on the Data Box Edge/Gateway device.
StorageAccountCredential	The storage account credential.
StorageAccountCredentialProperties	The storage account credential properties.
StorageAccountCredentialsCreateOrUpdateOptionalParams	Optional parameters.
StorageAccountCredentialsDeleteOptionalParams	Optional parameters.
StorageAccountCredentialsGetOptionalParams	Optional parameters.
StorageAccountCredentialsListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
StorageAccountCredentialsOperations	Interface representing a StorageAccountCredentials operations.
StorageAccountProperties	The storage account properties.
StorageAccountsCreateOrUpdateOptionalParams	Optional parameters.
StorageAccountsDeleteOptionalParams	Optional parameters.
StorageAccountsGetOptionalParams	Optional parameters.
StorageAccountsListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
StorageAccountsOperations	Interface representing a StorageAccounts operations.
SubscriptionProperties	model interface SubscriptionProperties
SubscriptionRegisteredFeatures	model interface SubscriptionRegisteredFeatures
SupportPackageRequestProperties	The share properties.
SupportPackagesOperations	Interface representing a SupportPackages operations.
SupportPackagesTriggerSupportPackageOptionalParams	Optional parameters.
SymmetricKey	Symmetric key for authentication.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrackingInfo	Tracking courier information.
Trigger	Trigger details.
TriggerSupportPackageRequest	The request object for trigger support package.
TriggersCreateOrUpdateOptionalParams	Optional parameters.
TriggersDeleteOptionalParams	Optional parameters.
TriggersGetOptionalParams	Optional parameters.
TriggersListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
TriggersOperations	Interface representing a Triggers operations.
UpdateDetails	Update Specific attributes
UpdateDownloadProgress	Details about the download progress of update.
UpdateInstallProgress	Progress details during installation of updates.
UpdateSummary	Details about ongoing updates and availability of updates on the device.
UpdateSummaryProperties	The device update information summary.
UploadCertificateRequest	The upload certificate request.
UploadCertificateResponse	The upload registration certificate response.
User	Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
UserAccessRight	The mapping between a particular user and the access type on the SMB share.
UserProperties	The user properties.
UsersCreateOrUpdateOptionalParams	Optional parameters.
UsersDeleteOptionalParams	Optional parameters.
UsersGetOptionalParams	Optional parameters.
UsersListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
UsersOperations	Interface representing a Users operations.
VmMemory	VmMemory Data.
VmPlacementRequestResult	List of VM sizes being checked for creation on appliance along with corresponding result.

Type Aliases

AccessLevel	Access level allowed for this remote application type KnownAccessLevel can be used interchangeably with AccessLevel, this enum contains the known values that the service supports. Known values supported by the service None ReadOnly ReadWrite FullAccess
AccountType	Type of storage accessed on the storage account. KnownAccountType can be used interchangeably with AccountType, this enum contains the known values that the service supports. Known values supported by the service GeneralPurposeStorage BlobStorage
AddonState	Addon Provisioning State KnownAddonState can be used interchangeably with AddonState, this enum contains the known values that the service supports. Known values supported by the service Invalid Creating Created Updating Reconfiguring Failed Deleting
AddonType	Addon type. KnownAddonType can be used interchangeably with AddonType, this enum contains the known values that the service supports. Known values supported by the service IotEdge ArcForKubernetes
AddonUnion	Alias for AddonUnion
AlertSeverity	Severity of the alert. KnownAlertSeverity can be used interchangeably with AlertSeverity, this enum contains the known values that the service supports. Known values supported by the service Informational Warning Critical
AuthenticationType	The authentication type. KnownAuthenticationType can be used interchangeably with AuthenticationType, this enum contains the known values that the service supports. Known values supported by the service Invalid AzureActiveDirectory
AzureContainerDataFormat	Storage format used for the file represented by the share. KnownAzureContainerDataFormat can be used interchangeably with AzureContainerDataFormat, this enum contains the known values that the service supports. Known values supported by the service BlockBlob PageBlob AzureFile
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ClientPermissionType	Type of access to be allowed for the client. KnownClientPermissionType can be used interchangeably with ClientPermissionType, this enum contains the known values that the service supports. Known values supported by the service NoAccess ReadOnly ReadWrite
ClusterWitnessType	Cluster Witness Type KnownClusterWitnessType can be used interchangeably with ClusterWitnessType, this enum contains the known values that the service supports. Known values supported by the service None Cloud FileShare
ContainerStatus	Current status of the container. KnownContainerStatus can be used interchangeably with ContainerStatus, this enum contains the known values that the service supports. Known values supported by the service OK Offline Unknown Updating NeedsAttention
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DataBoxEdgeDeviceKind	The kind of the device. KnownDataBoxEdgeDeviceKind can be used interchangeably with DataBoxEdgeDeviceKind, this enum contains the known values that the service supports. Known values supported by the service AzureDataBoxGateway AzureStackEdge AzureStackHub AzureModularDataCentre
DataBoxEdgeDeviceStatus	The status of the Data Box Edge/Gateway device. KnownDataBoxEdgeDeviceStatus can be used interchangeably with DataBoxEdgeDeviceStatus, this enum contains the known values that the service supports. Known values supported by the service ReadyToSetup Online Offline NeedsAttention Disconnected PartiallyDisconnected Maintenance
DataPolicy	Data policy of the share. KnownDataPolicy can be used interchangeably with DataPolicy, this enum contains the known values that the service supports. Known values supported by the service Cloud Local
DataResidencyType	DataResidencyType enum KnownDataResidencyType can be used interchangeably with DataResidencyType, this enum contains the known values that the service supports. Known values supported by the service GeoZoneReplication ZoneReplication
DayOfWeek	Type of DayOfWeek
DeviceType	The type of the Data Box Edge/Gateway device. KnownDeviceType can be used interchangeably with DeviceType, this enum contains the known values that the service supports. Known values supported by the service DataBoxEdgeDevice
DownloadPhase	The download phase. KnownDownloadPhase can be used interchangeably with DownloadPhase, this enum contains the known values that the service supports. Known values supported by the service Unknown Initializing Downloading Verifying
EncryptionAlgorithm	The algorithm used to encrypt "Value". KnownEncryptionAlgorithm can be used interchangeably with EncryptionAlgorithm, this enum contains the known values that the service supports. Known values supported by the service None AES256 RSAES_PKCS1_v_1_5
HostPlatformType	Platform where the runtime is hosted. KnownHostPlatformType can be used interchangeably with HostPlatformType, this enum contains the known values that the service supports. Known values supported by the service KubernetesCluster LinuxVM
InstallRebootBehavior	Indicates if updates are available and at least one of the updates needs a reboot. KnownInstallRebootBehavior can be used interchangeably with InstallRebootBehavior, this enum contains the known values that the service supports. Known values supported by the service NeverReboots RequiresReboot RequestReboot
InstallationImpact	Impact of Installing an updateType KnownInstallationImpact can be used interchangeably with InstallationImpact, this enum contains the known values that the service supports. Known values supported by the service None DeviceRebooted KubernetesWorkloadsDown
JobStatus	The current status of the job. KnownJobStatus can be used interchangeably with JobStatus, this enum contains the known values that the service supports. Known values supported by the service Invalid Running Succeeded Failed Canceled Paused Scheduled
JobType	The type of the job. KnownJobType can be used interchangeably with JobType, this enum contains the known values that the service supports. Known values supported by the service Invalid ScanForUpdates DownloadUpdates InstallUpdates RefreshShare RefreshContainer Backup Restore TriggerSupportPackage
KeyVaultSyncStatus	For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable. KnownKeyVaultSyncStatus can be used interchangeably with KeyVaultSyncStatus, this enum contains the known values that the service supports. Known values supported by the service KeyVaultSynced KeyVaultSyncFailed KeyVaultNotConfigured KeyVaultSyncPending KeyVaultSyncing KeyVaultNotSynced
KubernetesNodeType	Node type - Master/Worker KnownKubernetesNodeType can be used interchangeably with KubernetesNodeType, this enum contains the known values that the service supports. Known values supported by the service Invalid Master Worker
KubernetesState	State of Kubernetes deployment KnownKubernetesState can be used interchangeably with KubernetesState, this enum contains the known values that the service supports. Known values supported by the service Invalid Creating Created Updating Reconfiguring Failed Deleting
MetricAggregationType	Metric aggregation type. KnownMetricAggregationType can be used interchangeably with MetricAggregationType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified None Average Minimum Maximum Total Count
MetricCategory	Metric category. KnownMetricCategory can be used interchangeably with MetricCategory, this enum contains the known values that the service supports. Known values supported by the service Capacity Transaction
MetricUnit	Metric units. KnownMetricUnit can be used interchangeably with MetricUnit, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Percent Count Seconds Milliseconds Bytes BytesPerSecond CountPerSecond
MonitoringStatus	Current monitoring status of the share. KnownMonitoringStatus can be used interchangeably with MonitoringStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
MountType	Mounting type. KnownMountType can be used interchangeably with MountType, this enum contains the known values that the service supports. Known values supported by the service Volume HostPath
MsiIdentityType	Identity type KnownMsiIdentityType can be used interchangeably with MsiIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned
NetworkAdapterDhcpStatus	Value indicating whether this adapter has DHCP enabled. KnownNetworkAdapterDhcpStatus can be used interchangeably with NetworkAdapterDhcpStatus, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
NetworkAdapterRdmaStatus	Value indicating whether this adapter is RDMA capable. KnownNetworkAdapterRdmaStatus can be used interchangeably with NetworkAdapterRdmaStatus, this enum contains the known values that the service supports. Known values supported by the service Incapable Capable
NetworkAdapterStatus	Value indicating whether this adapter is valid. KnownNetworkAdapterStatus can be used interchangeably with NetworkAdapterStatus, this enum contains the known values that the service supports. Known values supported by the service Inactive Active
NetworkGroup	The network group. KnownNetworkGroup can be used interchangeably with NetworkGroup, this enum contains the known values that the service supports. Known values supported by the service None NonRDMA RDMA
NodeStatus	The current status of the individual node KnownNodeStatus can be used interchangeably with NodeStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown Up Down Rebooting ShuttingDown
OrderState	Status of the order as per the allowed status types. KnownOrderState can be used interchangeably with OrderState, this enum contains the known values that the service supports. Known values supported by the service Untracked AwaitingFulfillment AwaitingPreparation AwaitingShipment Shipped Arriving Delivered ReplacementRequested LostDevice Declined ReturnInitiated AwaitingReturnShipment ShippedBack CollectedAtMicrosoft AwaitingPickup PickupCompleted AwaitingDrop
PlatformType	Host OS supported by the Arc addon. KnownPlatformType can be used interchangeably with PlatformType, this enum contains the known values that the service supports. Known values supported by the service Windows Linux
PosixComplianceStatus	If provisioned storage is posix compliant. KnownPosixComplianceStatus can be used interchangeably with PosixComplianceStatus, this enum contains the known values that the service supports. Known values supported by the service Invalid Enabled Disabled
ProactiveDiagnosticsConsent	Proactive diagnostic collection consent flag KnownProactiveDiagnosticsConsent can be used interchangeably with ProactiveDiagnosticsConsent, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
RemoteApplicationType	Remote application type KnownRemoteApplicationType can be used interchangeably with RemoteApplicationType, this enum contains the known values that the service supports. Known values supported by the service Powershell WAC LocalUI AllApplications
ResourceMoveStatus	Denotes whether move operation is in progress KnownResourceMoveStatus can be used interchangeably with ResourceMoveStatus, this enum contains the known values that the service supports. Known values supported by the service None ResourceMoveInProgress ResourceMoveFailed
RoleStatus	Local Edge Management Status KnownRoleStatus can be used interchangeably with RoleStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
RoleTypes	Type of RoleTypes
RoleUnion	Alias for RoleUnion
SSLStatus	Signifies whether SSL needs to be enabled or not. KnownSSLStatus can be used interchangeably with SSLStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ShareAccessProtocol	Access protocol to be used by the share. KnownShareAccessProtocol can be used interchangeably with ShareAccessProtocol, this enum contains the known values that the service supports. Known values supported by the service SMB NFS
ShareAccessType	Type of access to be allowed on the share for this user. KnownShareAccessType can be used interchangeably with ShareAccessType, this enum contains the known values that the service supports. Known values supported by the service Change Read Custom
ShareStatus	Current status of the share. KnownShareStatus can be used interchangeably with ShareStatus, this enum contains the known values that the service supports. Known values supported by the service Offline Unknown OK Updating NeedsAttention
ShipmentType	Type of ShipmentType
SkuAvailability	Links to the next set of results KnownSkuAvailability can be used interchangeably with SkuAvailability, this enum contains the known values that the service supports. Known values supported by the service Available Unavailable
SkuName	The Sku name. KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service Gateway Edge TEA_1Node TEA_1Node_UPS TEA_1Node_Heater TEA_1Node_UPS_Heater TEA_4Node_Heater TEA_4Node_UPS_Heater TMA TDC TCA_Small GPU TCA_Large EdgeP_Base EdgeP_High EdgePR_Base EdgePR_Base_UPS EP2_64_1VPU_W EP2_128_1T4_Mx1_W EP2_256_2T4_W EdgeMR_Mini RCA_Small RCA_Large RDC Management EP2_64_Mx1_W EP2_128_GPU1_Mx1_W EP2_256_GPU2_Mx1 EdgeMR_TCP
SkuSignupOption	Sku can be signed up by customer or not. KnownSkuSignupOption can be used interchangeably with SkuSignupOption, this enum contains the known values that the service supports. Known values supported by the service None Available
SkuTier	The Sku tier. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Standard
SkuVersion	Availability of the Sku as preview/stable. KnownSkuVersion can be used interchangeably with SkuVersion, this enum contains the known values that the service supports. Known values supported by the service Stable Preview
StorageAccountStatus	Current status of the storage account KnownStorageAccountStatus can be used interchangeably with StorageAccountStatus, this enum contains the known values that the service supports. Known values supported by the service OK Offline Unknown Updating NeedsAttention
SubscriptionState	Type of SubscriptionState
TimeGrain	Type of TimeGrain
TriggerEventType	Trigger Kind. KnownTriggerEventType can be used interchangeably with TriggerEventType, this enum contains the known values that the service supports. Known values supported by the service FileEvent PeriodicTimerEvent
TriggerUnion	Alias for TriggerUnion
UpdateOperation	The current update operation. KnownUpdateOperation can be used interchangeably with UpdateOperation, this enum contains the known values that the service supports. Known values supported by the service None Scan Download Install
UpdateOperationStage	Current stage of the update operation. KnownUpdateOperationStage can be used interchangeably with UpdateOperationStage, this enum contains the known values that the service supports. Known values supported by the service Unknown Initial ScanStarted ScanComplete ScanFailed DownloadStarted DownloadComplete DownloadFailed InstallStarted InstallComplete InstallFailed RebootInitiated Success Failure RescanStarted RescanComplete RescanFailed
UpdateStatus	Status of the update. KnownUpdateStatus can be used interchangeably with UpdateStatus, this enum contains the known values that the service supports. Known values supported by the service DownloadPending DownloadStarted DownloadCompleted InstallStarted InstallCompleted
UpdateType	Type of the Update KnownUpdateType can be used interchangeably with UpdateType, this enum contains the known values that the service supports. Known values supported by the service Software Kubernetes Firmware
UserType	Type of the user. KnownUserType can be used interchangeably with UserType, this enum contains the known values that the service supports. Known values supported by the service Share LocalManagement ARM

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessLevel	Access level allowed for this remote application type
KnownAccountType	Type of storage accessed on the storage account.
KnownAddonState	Addon Provisioning State
KnownAddonType	Addon type.
KnownAlertSeverity	Severity of the alert.
KnownAuthenticationType	The authentication type.
KnownAzureContainerDataFormat	Storage format used for the file represented by the share.
KnownClientPermissionType	Type of access to be allowed for the client.
KnownClusterWitnessType	Cluster Witness Type
KnownContainerStatus	Current status of the container.
KnownCreatedByType	The kind of entity that created the resource.
KnownDataBoxEdgeDeviceKind	The kind of the device.
KnownDataBoxEdgeDeviceStatus	The status of the Data Box Edge/Gateway device.
KnownDataPolicy	Data policy of the share.
KnownDataResidencyType	DataResidencyType enum
KnownDayOfWeek	Known values of DayOfWeek that the service accepts.
KnownDeviceType	The type of the Data Box Edge/Gateway device.
KnownDownloadPhase	The download phase.
KnownEncryptionAlgorithm	The algorithm used to encrypt "Value".
KnownHostPlatformType	Platform where the runtime is hosted.
KnownInstallRebootBehavior	Indicates if updates are available and at least one of the updates needs a reboot.
KnownInstallationImpact	Impact of Installing an updateType
KnownJobStatus	The current status of the job.
KnownJobType	The type of the job.
KnownKeyVaultSyncStatus	For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable.
KnownKubernetesNodeType	Node type - Master/Worker
KnownKubernetesState	State of Kubernetes deployment
KnownMetricAggregationType	Metric aggregation type.
KnownMetricCategory	Metric category.
KnownMetricUnit	Metric units.
KnownMonitoringStatus	Current monitoring status of the share.
KnownMountType	Mounting type.
KnownMsiIdentityType	Identity type
KnownNetworkAdapterDhcpStatus	Value indicating whether this adapter has DHCP enabled.
KnownNetworkAdapterRdmaStatus	Value indicating whether this adapter is RDMA capable.
KnownNetworkAdapterStatus	Value indicating whether this adapter is valid.
KnownNetworkGroup	The network group.
KnownNodeStatus	The current status of the individual node
KnownOrderState	Status of the order as per the allowed status types.
KnownPlatformType	Host OS supported by the Arc addon.
KnownPosixComplianceStatus	If provisioned storage is posix compliant.
KnownProactiveDiagnosticsConsent	Proactive diagnostic collection consent flag
KnownRemoteApplicationType	Remote application type
KnownResourceMoveStatus	Denotes whether move operation is in progress
KnownRoleStatus	Local Edge Management Status
KnownRoleTypes	Known values of RoleTypes that the service accepts.
KnownSSLStatus	Signifies whether SSL needs to be enabled or not.
KnownShareAccessProtocol	Access protocol to be used by the share.
KnownShareAccessType	Type of access to be allowed on the share for this user.
KnownShareStatus	Current status of the share.
KnownShipmentType	Known values of ShipmentType that the service accepts.
KnownSkuAvailability	Links to the next set of results
KnownSkuName	The Sku name.
KnownSkuSignupOption	Sku can be signed up by customer or not.
KnownSkuTier	The Sku tier.
KnownSkuVersion	Availability of the Sku as preview/stable.
KnownStorageAccountStatus	Current status of the storage account
KnownSubscriptionState	Known values of SubscriptionState that the service accepts.
KnownTimeGrain	Known values of TimeGrain that the service accepts.
KnownTriggerEventType	Trigger Kind.
KnownUpdateOperation	The current update operation.
KnownUpdateOperationStage	Current stage of the update operation.
KnownUpdateStatus	Status of the update.
KnownUpdateType	Type of the Update
KnownUserType	Type of the user.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(DataBoxEdgeManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(DataBoxEdgeManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: DataBoxEdgeManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

DataBoxEdgeManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor