@azure/arm-databoxedge-profile-2020-09-01-hybrid package
Classes
DataBoxEdgeManagementClient |
Interfaces
ARMBaseModel |
Represents the base class for all object models. |
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. |
AsymmetricEncryptedSecret |
Represent the secrets intended for encryption with asymmetric key pair. |
Authentication |
Authentication mechanism for IoT devices. |
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. |
CloudError |
An error response from the service. |
CloudErrorBody |
An error response from the service. |
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. |
DataBoxEdgeDevice |
The Data Box Edge/Gateway device. |
DataBoxEdgeDeviceExtendedInfo |
The extended Info of the Data Box Edge/Gateway device. |
DataBoxEdgeDeviceList |
The collection of Data Box Edge/Gateway devices. |
DataBoxEdgeDevicePatch |
The Data Box Edge/Gateway device patch. |
DataBoxEdgeManagementClientOptionalParams |
Optional parameters. |
Devices |
Interface representing a Devices. |
DevicesCreateOrUpdateOptionalParams |
Optional parameters. |
DevicesCreateOrUpdateSecuritySettingsOptionalParams |
Optional parameters. |
DevicesDeleteOptionalParams |
Optional parameters. |
DevicesDownloadUpdatesOptionalParams |
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. |
DevicesUpdateOptionalParams |
Optional parameters. |
DevicesUploadCertificateOptionalParams |
Optional parameters. |
FileEventTrigger |
Trigger details. |
FileSourceInfo |
File source details. |
IoTDeviceInfo |
Metadata of IoT device/IoT Edge device to be configured. |
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. |
MetricDimensionV1 |
Metric Dimension v1. |
MetricSpecificationV1 |
Metric specification version 1. |
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 |
NodeList |
Collection of Nodes. |
Nodes |
Interface representing a Nodes. |
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. |
PeriodicTimerEventTrigger |
Trigger details. |
PeriodicTimerSourceInfo |
Periodic timer event source. |
RefreshDetails |
Fields for tracking refresh job on the share or container. |
ResourceTypeSku |
SkuInformation 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. |
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. |
SkuCost |
The metadata for retrieving price info. |
SkuInformationList |
List of SKU Information objects |
SkuLocationInfo |
The location info. |
SkuRestriction |
The restrictions because of which SKU cannot be used. |
SkuRestrictionInfo |
The restriction info with locations and zones. |
Skus |
Interface representing a Skus. |
SkusListOptionalParams |
Optional parameters. |
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. |
SymmetricKey |
Symmetric key for authentication. |
TrackingInfo |
Tracking courier information. |
Trigger |
Trigger details. |
TriggerList |
Collection of all trigger on the data box edge device. |
Triggers |
Interface representing a Triggers. |
TriggersCreateOrUpdateOptionalParams |
Optional parameters. |
TriggersDeleteOptionalParams |
Optional parameters. |
TriggersGetOptionalParams |
Optional parameters. |
TriggersListByDataBoxEdgeDeviceNextOptionalParams |
Optional parameters. |
TriggersListByDataBoxEdgeDeviceOptionalParams |
Optional parameters. |
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
AccountType |
Defines values for AccountType. Known values supported by the serviceGeneralPurposeStorage |
AlertSeverity |
Defines values for AlertSeverity. Known values supported by the serviceInformational |
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. Known values supported by the serviceInvalid |
AzureContainerDataFormat |
Defines values for AzureContainerDataFormat. Known values supported by the serviceBlockBlob |
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. Known values supported by the serviceNoAccess |
ContainerStatus |
Defines values for ContainerStatus. Known values supported by the serviceOK |
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. |
DataBoxEdgeDeviceStatus |
Defines values for DataBoxEdgeDeviceStatus. Known values supported by the serviceReadyToSetup |
DataPolicy |
Defines values for DataPolicy. Known values supported by the serviceCloud |
DayOfWeek |
Defines values for DayOfWeek. Known values supported by the serviceSunday |
DeviceType |
Defines values for DeviceType. Known values supported by the serviceDataBoxEdgeDevice |
DevicesCreateOrUpdateResponse |
Contains response data for the createOrUpdate 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. |
DevicesUpdateResponse |
Contains response data for the update operation. |
DevicesUploadCertificateResponse |
Contains response data for the uploadCertificate operation. |
DownloadPhase |
Defines values for DownloadPhase. Known values supported by the serviceUnknown |
EncryptionAlgorithm |
Defines values for EncryptionAlgorithm. Known values supported by the serviceNone |
InstallRebootBehavior |
Defines values for InstallRebootBehavior. Known values supported by the serviceNeverReboots |
JobStatus |
Defines values for JobStatus. Known values supported by the serviceInvalid |
JobType |
Defines values for JobType. Known values supported by the serviceInvalid |
JobsGetResponse |
Contains response data for the get operation. |
MetricAggregationType |
Defines values for MetricAggregationType. Known values supported by the serviceNotSpecified |
MetricCategory |
Defines values for MetricCategory. Known values supported by the serviceCapacity |
MetricUnit |
Defines values for MetricUnit. Known values supported by the serviceNotSpecified |
MonitoringStatus |
Defines values for MonitoringStatus. Known values supported by the serviceEnabled |
NetworkAdapterDhcpStatus |
Defines values for NetworkAdapterDhcpStatus. Known values supported by the serviceDisabled |
NetworkAdapterRdmaStatus |
Defines values for NetworkAdapterRdmaStatus. Known values supported by the serviceIncapable |
NetworkAdapterStatus |
Defines values for NetworkAdapterStatus. Known values supported by the serviceInactive |
NetworkGroup |
Defines values for NetworkGroup. Known values supported by the serviceNone |
NodeStatus |
Defines values for NodeStatus. Known values supported by the serviceUnknown |
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. Known values supported by the serviceUntracked |
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. |
PlatformType |
Defines values for PlatformType. Known values supported by the serviceWindows |
RoleStatus |
Defines values for RoleStatus. Known values supported by the serviceEnabled |
RoleTypes |
Defines values for RoleTypes. Known values supported by the serviceIOT |
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. Known values supported by the serviceEnabled |
ShareAccessProtocol |
Defines values for ShareAccessProtocol. Known values supported by the serviceSMB |
ShareAccessType |
Defines values for ShareAccessType. Known values supported by the serviceChange |
ShareStatus |
Defines values for ShareStatus. Known values supported by the serviceOffline |
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. |
SkuName |
Defines values for SkuName. Known values supported by the serviceGateway |
SkuRestrictionReasonCode |
Defines values for SkuRestrictionReasonCode. Known values supported by the serviceNotAvailableForSubscription |
SkuTier |
Defines values for SkuTier. Known values supported by the serviceStandard |
SkusListResponse |
Contains response data for the list operation. |
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. Known values supported by the serviceOK |
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. |
TimeGrain |
Defines values for TimeGrain. Known values supported by the servicePT1M |
TriggerEventType |
Defines values for TriggerEventType. Known values supported by the serviceFileEvent |
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. Known values supported by the serviceNone |
UpdateOperationStage |
Defines values for UpdateOperationStage. Known values supported by the serviceUnknown |
UserType |
Defines values for UserType. Known values supported by the serviceShare |
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
KnownAccountType |
Known values of AccountType 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. |
KnownDataBoxEdgeDeviceStatus |
Known values of DataBoxEdgeDeviceStatus that the service accepts. |
KnownDataPolicy |
Known values of DataPolicy 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. |
KnownInstallRebootBehavior |
Known values of InstallRebootBehavior that the service accepts. |
KnownJobStatus |
Known values of JobStatus that the service accepts. |
KnownJobType |
Known values of JobType 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. |
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. |
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. |
KnownSkuName |
Known values of SkuName that the service accepts. |
KnownSkuRestrictionReasonCode |
Known values of SkuRestrictionReasonCode that the service accepts. |
KnownSkuTier |
Known values of SkuTier that the service accepts. |
KnownStorageAccountStatus |
Known values of StorageAccountStatus 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. |
KnownUserType |
Known values of UserType that the service accepts. |
Functions
get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value
produced by the byPage
iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value
on the IteratorResult from a byPage
iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.