@azure/arm-databoxedge package

Classes

DataBoxEdgeManagementClient

Interfaces

ARMBaseModel	Represents the base class for all object models.
Addon	Role Addon
AddonList	Collection of all the Role addon on the Azure Stack Edge device.
Addons	Interface representing a Addons.
AddonsCreateOrUpdateOptionalParams	Optional parameters.
AddonsDeleteOptionalParams	Optional parameters.
AddonsGetOptionalParams	Optional parameters.
AddonsListByRoleNextOptionalParams	Optional parameters.
AddonsListByRoleOptionalParams	Optional parameters.
Address	The shipping address of the customer.
Alert	Alert on the data box edge/gateway device.
AlertErrorDetails	Error details for the alert.
AlertList	Collection of alerts.
Alerts	Interface representing a Alerts.
AlertsGetOptionalParams	Optional parameters.
AlertsListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
AlertsListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
ArcAddon	Arc Addon.
AsymmetricEncryptedSecret	Represent the secrets intended for encryption with asymmetric key pair.
Authentication	Authentication mechanism for IoT devices.
AvailableSkus	Interface representing a AvailableSkus.
AvailableSkusListNextOptionalParams	Optional parameters.
AvailableSkusListOptionalParams	Optional parameters.
AzureContainerInfo	Azure container mapping of the endpoint.
BandwidthSchedule	The bandwidth schedule details.
BandwidthSchedules	Interface representing a BandwidthSchedules.
BandwidthSchedulesCreateOrUpdateOptionalParams	Optional parameters.
BandwidthSchedulesDeleteOptionalParams	Optional parameters.
BandwidthSchedulesGetOptionalParams	Optional parameters.
BandwidthSchedulesList	The collection of bandwidth schedules.
BandwidthSchedulesListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
BandwidthSchedulesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
ClientAccessRight	The mapping between a particular client IP and the type of access client has on the NFS share.
CloudEdgeManagementRole	CloudEdgeManagementRole role.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
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.
ContainerList	Collection of all the containers on the Data Box Edge/Gateway device.
Containers	Interface representing a Containers.
ContainersCreateOrUpdateOptionalParams	Optional parameters.
ContainersDeleteOptionalParams	Optional parameters.
ContainersGetOptionalParams	Optional parameters.
ContainersListByStorageAccountNextOptionalParams	Optional parameters.
ContainersListByStorageAccountOptionalParams	Optional parameters.
ContainersRefreshOptionalParams	Optional parameters.
DCAccessCode	DC Access code in the case of Self Managed Shipping.
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.
DataBoxEdgeDeviceList	The collection of Data Box Edge/Gateway devices.
DataBoxEdgeDevicePatch	The Data Box Edge/Gateway device patch.
DataBoxEdgeManagementClientOptionalParams	Optional parameters.
DataBoxEdgeMoveRequest	Resource Move details
DataBoxEdgeSku	The Sku information.
DataBoxEdgeSkuList	List of SKU Information objects.
DataResidency	Wraps data-residency related information for edge-resource and this should be used with ARM layer.
Devices	Interface representing a Devices.
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.
DevicesListByResourceGroupNextOptionalParams	Optional parameters.
DevicesListByResourceGroupOptionalParams	Optional parameters.
DevicesListBySubscriptionNextOptionalParams	Optional parameters.
DevicesListBySubscriptionOptionalParams	Optional parameters.
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.
DiagnosticSettings	Interface representing a DiagnosticSettings.
DiagnosticSettingsGetDiagnosticProactiveLogCollectionSettingsOptionalParams	Optional parameters.
DiagnosticSettingsGetDiagnosticRemoteSupportSettingsOptionalParams	Optional parameters.
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.
GenerateCertResponse	Used in activation key generation flow.
ImageRepositoryCredential	Image repository credential.
IoTAddon	IoT Addon.
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.
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.
Jobs	Interface representing a Jobs.
JobsGetOptionalParams	Optional parameters.
KubernetesClusterInfo	Kubernetes cluster configuration
KubernetesIPConfiguration	Kubernetes node IP configuration
KubernetesRole	Kubernetes role.
KubernetesRoleCompute	Kubernetes role compute resource
KubernetesRoleNetwork	Kubernetes role network resource
KubernetesRoleResources	Kubernetes role resources
KubernetesRoleStorage	Kubernetes role storage resource
KubernetesRoleStorageClassInfo	Kubernetes storage class info.
LoadBalancerConfig	Load balancer configuration
MECRole	MEC role.
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.
MonitoringConfig	Interface representing a MonitoringConfig.
MonitoringConfigCreateOrUpdateOptionalParams	Optional parameters.
MonitoringConfigDeleteOptionalParams	Optional parameters.
MonitoringConfigGetOptionalParams	Optional parameters.
MonitoringConfigListNextOptionalParams	Optional parameters.
MonitoringConfigListOptionalParams	Optional parameters.
MonitoringMetricConfiguration	The metric setting details for the role
MonitoringMetricConfigurationList	Collection of metric configurations.
MountPointMap	The share mount point.
NetworkAdapter	Represents the networkAdapter on a device.
NetworkAdapterPosition	The network adapter position.
NetworkSettings	The network settings of a device.
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
NodeList	Collection of Nodes.
Nodes	Interface representing a Nodes.
NodesListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
NodesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
Operation	Operations.
OperationDisplay	Operation display properties.
Operations	Interface representing a Operations.
OperationsList	The list of operations used for the discovery of available provider operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OperationsStatus	Interface representing a OperationsStatus.
OperationsStatusGetOptionalParams	Optional parameters.
Order	The order details.
OrderList	List of order entities.
OrderStatus	Represents a single status change.
Orders	Interface representing a Orders.
OrdersCreateOrUpdateOptionalParams	Optional parameters.
OrdersDeleteOptionalParams	Optional parameters.
OrdersGetOptionalParams	Optional parameters.
OrdersListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
OrdersListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
OrdersListDCAccessCodeOptionalParams	Optional parameters.
PeriodicTimerEventTrigger	Trigger details.
PeriodicTimerSourceInfo	Periodic timer event source.
RefreshDetails	Fields for tracking refresh job on the share or container.
RemoteSupportSettings	RemoteApplicationType for which remote support settings is being modified
ResourceIdentity	Msi identity details of the resource
ResourceMoveDetails	Fields for tracking resource move
ResourceTypeSku	Resource type Sku object
Role	Compute role.
RoleList	Collection of all the roles on the Data Box Edge device.
RoleSinkInfo	Compute role against which events will be raised.
Roles	Interface representing a Roles.
RolesCreateOrUpdateOptionalParams	Optional parameters.
RolesDeleteOptionalParams	Optional parameters.
RolesGetOptionalParams	Optional parameters.
RolesListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
RolesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
Secret	Holds device secret either as a KeyVault reference or as an encrypted value.
SecuritySettings	The security settings of a device.
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.
ShareList	Collection of all the shares on the Data Box Edge/Gateway device.
Shares	Interface representing a Shares.
SharesCreateOrUpdateOptionalParams	Optional parameters.
SharesDeleteOptionalParams	Optional parameters.
SharesGetOptionalParams	Optional parameters.
SharesListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
SharesListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
SharesRefreshOptionalParams	Optional parameters.
Sku	The SKU type.
SkuCapability	The metadata to describe the capability.
SkuCost	The metadata for retrieving price info.
SkuInformation	Sku information
SkuInformationList	List of SKU Information objects
SkuLocationInfo	The location info.
StorageAccount	Represents a Storage Account on the Data Box Edge/Gateway device.
StorageAccountCredential	The storage account credential.
StorageAccountCredentialList	The collection of storage account credentials.
StorageAccountCredentials	Interface representing a StorageAccountCredentials.
StorageAccountCredentialsCreateOrUpdateOptionalParams	Optional parameters.
StorageAccountCredentialsDeleteOptionalParams	Optional parameters.
StorageAccountCredentialsGetOptionalParams	Optional parameters.
StorageAccountCredentialsListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
StorageAccountCredentialsListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
StorageAccountList	Collection of all the Storage Accounts on the Data Box Edge/Gateway device.
StorageAccounts	Interface representing a StorageAccounts.
StorageAccountsCreateOrUpdateOptionalParams	Optional parameters.
StorageAccountsDeleteOptionalParams	Optional parameters.
StorageAccountsGetOptionalParams	Optional parameters.
StorageAccountsListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
StorageAccountsListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
SubscriptionRegisteredFeatures
SupportPackages	Interface representing a SupportPackages.
SupportPackagesTriggerSupportPackageOptionalParams	Optional parameters.
SymmetricKey	Symmetric key for authentication.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackingInfo	Tracking courier information.
Trigger	Trigger details.
TriggerList	Collection of all trigger on the data box edge device.
TriggerSupportPackageRequest	The request object for trigger support package.
Triggers	Interface representing a Triggers.
TriggersCreateOrUpdateOptionalParams	Optional parameters.
TriggersDeleteOptionalParams	Optional parameters.
TriggersGetOptionalParams	Optional parameters.
TriggersListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
TriggersListByDataBoxEdgeDeviceOptionalParams	Optional parameters.
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.
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.
UserList	Collection of users.
Users	Interface representing a Users.
UsersCreateOrUpdateOptionalParams	Optional parameters.
UsersDeleteOptionalParams	Optional parameters.
UsersGetOptionalParams	Optional parameters.
UsersListByDataBoxEdgeDeviceNextOptionalParams	Optional parameters.
UsersListByDataBoxEdgeDeviceOptionalParams	Optional parameters.

Type Aliases

AccessLevel	Defines values for AccessLevel. 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	Defines values for AccountType. 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	Defines values for AddonState. 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	Defines values for AddonType. 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
AddonsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AddonsGetResponse	Contains response data for the get operation.
AddonsListByRoleNextResponse	Contains response data for the listByRoleNext operation.
AddonsListByRoleResponse	Contains response data for the listByRole operation.
AlertSeverity	Defines values for AlertSeverity. 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
AlertsGetResponse	Contains response data for the get operation.
AlertsListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
AlertsListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
AuthenticationType	Defines values for AuthenticationType. 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
AvailableSkusListNextResponse	Contains response data for the listNext operation.
AvailableSkusListResponse	Contains response data for the list operation.
AzureContainerDataFormat	Defines values for AzureContainerDataFormat. 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
BandwidthSchedulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
BandwidthSchedulesGetResponse	Contains response data for the get operation.
BandwidthSchedulesListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
BandwidthSchedulesListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
ClientPermissionType	Defines values for ClientPermissionType. 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
ContainerStatus	Defines values for ContainerStatus. 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
ContainersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ContainersGetResponse	Contains response data for the get operation.
ContainersListByStorageAccountNextResponse	Contains response data for the listByStorageAccountNext operation.
ContainersListByStorageAccountResponse	Contains response data for the listByStorageAccount operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DataBoxEdgeDeviceKind	Defines values for DataBoxEdgeDeviceKind. 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	Defines values for DataBoxEdgeDeviceStatus. 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	Defines values for DataPolicy. 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	Defines values for DataResidencyType. 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	Defines values for DayOfWeek. KnownDayOfWeek can be used interchangeably with DayOfWeek, this enum contains the known values that the service supports. Known values supported by the service Sunday Monday Tuesday Wednesday Thursday Friday Saturday
DeviceType	Defines values for DeviceType. KnownDeviceType can be used interchangeably with DeviceType, this enum contains the known values that the service supports. Known values supported by the service DataBoxEdgeDevice
DevicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DevicesGenerateCertificateResponse	Contains response data for the generateCertificate operation.
DevicesGetExtendedInformationResponse	Contains response data for the getExtendedInformation operation.
DevicesGetNetworkSettingsResponse	Contains response data for the getNetworkSettings operation.
DevicesGetResponse	Contains response data for the get operation.
DevicesGetUpdateSummaryResponse	Contains response data for the getUpdateSummary operation.
DevicesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
DevicesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
DevicesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
DevicesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
DevicesUpdateExtendedInformationResponse	Contains response data for the updateExtendedInformation operation.
DevicesUpdateResponse	Contains response data for the update operation.
DevicesUploadCertificateResponse	Contains response data for the uploadCertificate operation.
DiagnosticSettingsGetDiagnosticProactiveLogCollectionSettingsResponse	Contains response data for the getDiagnosticProactiveLogCollectionSettings operation.
DiagnosticSettingsGetDiagnosticRemoteSupportSettingsResponse	Contains response data for the getDiagnosticRemoteSupportSettings operation.
DiagnosticSettingsUpdateDiagnosticProactiveLogCollectionSettingsResponse	Contains response data for the updateDiagnosticProactiveLogCollectionSettings operation.
DiagnosticSettingsUpdateDiagnosticRemoteSupportSettingsResponse	Contains response data for the updateDiagnosticRemoteSupportSettings operation.
DownloadPhase	Defines values for DownloadPhase. 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	Defines values for EncryptionAlgorithm. 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	Defines values for HostPlatformType. 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	Defines values for InstallRebootBehavior. 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	Defines values for InstallationImpact. 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	Defines values for JobStatus. 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	Defines values for JobType. 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
JobsGetResponse	Contains response data for the get operation.
KeyVaultSyncStatus	Defines values for KeyVaultSyncStatus. 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	Defines values for KubernetesNodeType. 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	Defines values for KubernetesState. 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	Defines values for MetricAggregationType. 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	Defines values for MetricCategory. 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	Defines values for MetricUnit. 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
MonitoringConfigCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
MonitoringConfigGetResponse	Contains response data for the get operation.
MonitoringConfigListNextResponse	Contains response data for the listNext operation.
MonitoringConfigListResponse	Contains response data for the list operation.
MonitoringStatus	Defines values for MonitoringStatus. 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	Defines values for MountType. 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	Defines values for MsiIdentityType. 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	Defines values for NetworkAdapterDhcpStatus. 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	Defines values for NetworkAdapterRdmaStatus. 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	Defines values for NetworkAdapterStatus. 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	Defines values for NetworkGroup. 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	Defines values for NodeStatus. 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
NodesListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
NodesListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
OperationsStatusGetResponse	Contains response data for the get operation.
OrderState	Defines values for OrderState. 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
OrdersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
OrdersGetResponse	Contains response data for the get operation.
OrdersListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
OrdersListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
OrdersListDCAccessCodeResponse	Contains response data for the listDCAccessCode operation.
PlatformType	Defines values for PlatformType. 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	Defines values for PosixComplianceStatus. 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	Defines values for ProactiveDiagnosticsConsent. 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	Defines values for RemoteApplicationType. 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	Defines values for ResourceMoveStatus. 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	Defines values for RoleStatus. 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	Defines values for RoleTypes. KnownRoleTypes can be used interchangeably with RoleTypes, this enum contains the known values that the service supports. Known values supported by the service IOT ASA Functions Cognitive MEC CloudEdgeManagement Kubernetes
RoleUnion
RolesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
RolesGetResponse	Contains response data for the get operation.
RolesListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
RolesListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
SSLStatus	Defines values for SSLStatus. 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	Defines values for ShareAccessProtocol. 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	Defines values for ShareAccessType. 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	Defines values for ShareStatus. 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
SharesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SharesGetResponse	Contains response data for the get operation.
SharesListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
SharesListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
ShipmentType	Defines values for ShipmentType. KnownShipmentType can be used interchangeably with ShipmentType, this enum contains the known values that the service supports. Known values supported by the service NotApplicable ShippedToCustomer SelfPickup
SkuAvailability	Defines values for SkuAvailability. 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	Defines values for SkuName. 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
SkuSignupOption	Defines values for SkuSignupOption. 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	Defines values for SkuTier. 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	Defines values for SkuVersion. 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
StorageAccountCredentialsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
StorageAccountCredentialsGetResponse	Contains response data for the get operation.
StorageAccountCredentialsListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
StorageAccountCredentialsListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
StorageAccountStatus	Defines values for StorageAccountStatus. 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
StorageAccountsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
StorageAccountsGetResponse	Contains response data for the get operation.
StorageAccountsListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
StorageAccountsListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
SubscriptionState	Defines values for SubscriptionState. KnownSubscriptionState can be used interchangeably with SubscriptionState, this enum contains the known values that the service supports. Known values supported by the service Registered Warned Suspended Deleted Unregistered
TimeGrain	Defines values for TimeGrain. KnownTimeGrain can be used interchangeably with TimeGrain, this enum contains the known values that the service supports. Known values supported by the service PT1M PT5M PT15M PT30M PT1H PT6H PT12H PT1D
TriggerEventType	Defines values for TriggerEventType. 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
TriggersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
TriggersGetResponse	Contains response data for the get operation.
TriggersListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
TriggersListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.
UpdateOperation	Defines values for UpdateOperation. 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	Defines values for UpdateOperationStage. 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	Defines values for UpdateStatus. 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	Defines values for UpdateType. 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	Defines values for UserType. 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
UsersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
UsersGetResponse	Contains response data for the get operation.
UsersListByDataBoxEdgeDeviceNextResponse	Contains response data for the listByDataBoxEdgeDeviceNext operation.
UsersListByDataBoxEdgeDeviceResponse	Contains response data for the listByDataBoxEdgeDevice operation.

Enums

KnownAccessLevel	Known values of AccessLevel that the service accepts.
KnownAccountType	Known values of AccountType that the service accepts.
KnownAddonState	Known values of AddonState that the service accepts.
KnownAddonType	Known values of AddonType that the service accepts.
KnownAlertSeverity	Known values of AlertSeverity that the service accepts.
KnownAuthenticationType	Known values of AuthenticationType that the service accepts.
KnownAzureContainerDataFormat	Known values of AzureContainerDataFormat that the service accepts.
KnownClientPermissionType	Known values of ClientPermissionType that the service accepts.
KnownContainerStatus	Known values of ContainerStatus that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDataBoxEdgeDeviceKind	Known values of DataBoxEdgeDeviceKind that the service accepts.
KnownDataBoxEdgeDeviceStatus	Known values of DataBoxEdgeDeviceStatus that the service accepts.
KnownDataPolicy	Known values of DataPolicy that the service accepts.
KnownDataResidencyType	Known values of DataResidencyType that the service accepts.
KnownDayOfWeek	Known values of DayOfWeek that the service accepts.
KnownDeviceType	Known values of DeviceType that the service accepts.
KnownDownloadPhase	Known values of DownloadPhase that the service accepts.
KnownEncryptionAlgorithm	Known values of EncryptionAlgorithm that the service accepts.
KnownHostPlatformType	Known values of HostPlatformType that the service accepts.
KnownInstallRebootBehavior	Known values of InstallRebootBehavior that the service accepts.
KnownInstallationImpact	Known values of InstallationImpact that the service accepts.
KnownJobStatus	Known values of JobStatus that the service accepts.
KnownJobType	Known values of JobType that the service accepts.
KnownKeyVaultSyncStatus	Known values of KeyVaultSyncStatus that the service accepts.
KnownKubernetesNodeType	Known values of KubernetesNodeType that the service accepts.
KnownKubernetesState	Known values of KubernetesState that the service accepts.
KnownMetricAggregationType	Known values of MetricAggregationType that the service accepts.
KnownMetricCategory	Known values of MetricCategory that the service accepts.
KnownMetricUnit	Known values of MetricUnit that the service accepts.
KnownMonitoringStatus	Known values of MonitoringStatus that the service accepts.
KnownMountType	Known values of MountType that the service accepts.
KnownMsiIdentityType	Known values of MsiIdentityType that the service accepts.
KnownNetworkAdapterDhcpStatus	Known values of NetworkAdapterDhcpStatus that the service accepts.
KnownNetworkAdapterRdmaStatus	Known values of NetworkAdapterRdmaStatus that the service accepts.
KnownNetworkAdapterStatus	Known values of NetworkAdapterStatus that the service accepts.
KnownNetworkGroup	Known values of NetworkGroup that the service accepts.
KnownNodeStatus	Known values of NodeStatus that the service accepts.
KnownOrderState	Known values of OrderState that the service accepts.
KnownPlatformType	Known values of PlatformType that the service accepts.
KnownPosixComplianceStatus	Known values of PosixComplianceStatus that the service accepts.
KnownProactiveDiagnosticsConsent	Known values of ProactiveDiagnosticsConsent that the service accepts.
KnownRemoteApplicationType	Known values of RemoteApplicationType that the service accepts.
KnownResourceMoveStatus	Known values of ResourceMoveStatus that the service accepts.
KnownRoleStatus	Known values of RoleStatus that the service accepts.
KnownRoleTypes	Known values of RoleTypes that the service accepts.
KnownSSLStatus	Known values of SSLStatus that the service accepts.
KnownShareAccessProtocol	Known values of ShareAccessProtocol that the service accepts.
KnownShareAccessType	Known values of ShareAccessType that the service accepts.
KnownShareStatus	Known values of ShareStatus that the service accepts.
KnownShipmentType	Known values of ShipmentType that the service accepts.
KnownSkuAvailability	Known values of SkuAvailability that the service accepts.
KnownSkuName	Known values of SkuName that the service accepts.
KnownSkuSignupOption	Known values of SkuSignupOption that the service accepts.
KnownSkuTier	Known values of SkuTier that the service accepts.
KnownSkuVersion	Known values of SkuVersion that the service accepts.
KnownStorageAccountStatus	Known values of StorageAccountStatus that the service accepts.
KnownSubscriptionState	Known values of SubscriptionState that the service accepts.
KnownTimeGrain	Known values of TimeGrain that the service accepts.
KnownTriggerEventType	Known values of TriggerEventType that the service accepts.
KnownUpdateOperation	Known values of UpdateOperation that the service accepts.
KnownUpdateOperationStage	Known values of UpdateOperationStage that the service accepts.
KnownUpdateStatus	Known values of UpdateStatus that the service accepts.
KnownUpdateType	Known values of UpdateType that the service accepts.
KnownUserType	Known values of UserType that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().