Package-level declarations

Types

Link copied to clipboard
data class AddressResponse(val addressLine1: String? = null, val addressLine2: String? = null, val addressLine3: String? = null, val city: String? = null, val country: String, val postalCode: String? = null, val state: String? = null)

The shipping address of the customer.

Link copied to clipboard
data class AsymmetricEncryptedSecretResponse(val encryptionAlgorithm: String, val encryptionCertThumbprint: String? = null, val value: String)

Represent the secrets intended for encryption with asymmetric key pair.

Link copied to clipboard
data class AuthenticationResponse(val symmetricKey: SymmetricKeyResponse? = null)

Authentication mechanism for IoT devices.

Link copied to clipboard
data class AzureContainerInfoResponse(val containerName: String, val dataFormat: String, val storageAccountCredentialId: String)

Azure container mapping of the endpoint.

Link copied to clipboard
data class ClientAccessRightResponse(val accessPermission: String, val client: String)

The mapping between a particular client IP and the type of access client has on the NFS share.

Link copied to clipboard
data class CniConfigResponse(val podSubnet: String, val serviceSubnet: String, val type: String, val version: String)

Cni configuration

Link copied to clipboard
data class ComputeResourceResponse(val memoryInGB: Double, val processorCount: Int)

Compute infrastructure Resource

Link copied to clipboard
data class ContactDetailsResponse(val companyName: String, val contactPerson: String, val emailList: List<String>, val phone: String)

Contains all the contact details of the customer.

Link copied to clipboard
data class DataResidencyResponse(val type: String? = null)

Wraps data-residency related information for edge-resource and this should be used with ARM layer.

Link copied to clipboard
data class EdgeProfileResponse(val subscription: EdgeProfileSubscriptionResponse? = null)

Details about Edge Profile for the resource

Link copied to clipboard
data class EdgeProfileSubscriptionResponse(val id: String? = null, val locationPlacementId: String? = null, val quotaId: String? = null, val registeredFeatures: List<SubscriptionRegisteredFeaturesResponse>? = null, val registrationDate: String? = null, val registrationId: String? = null, val serializedDetails: String? = null, val state: String? = null, val subscriptionId: String? = null, val tenantId: String? = null)

Subscription details for the Edge Profile

Link copied to clipboard
data class EtcdInfoResponse(val type: String, val version: String)

Etcd configuration

Link copied to clipboard
data class FileSourceInfoResponse(val shareId: String)

File source details.

Link copied to clipboard
data class GetArcAddonResult(val azureApiVersion: String, val hostPlatform: String, val hostPlatformType: String, val id: String, val kind: String, val name: String, val provisioningState: String, val resourceGroupName: String, val resourceLocation: String, val resourceName: String, val subscriptionId: String, val systemData: SystemDataResponse, val type: String, val version: String)

Arc Addon.

Link copied to clipboard
data class GetBandwidthScheduleResult(val azureApiVersion: String, val days: List<String>, val id: String, val name: String, val rateInMbps: Int, val start: String, val stop: String, val systemData: SystemDataResponse, val type: String)

The bandwidth schedule details.

Link copied to clipboard
data class GetCloudEdgeManagementRoleResult(val azureApiVersion: String, val edgeProfile: EdgeProfileResponse, val id: String, val kind: String, val localManagementStatus: String, val name: String, val roleStatus: String, val systemData: SystemDataResponse, val type: String)

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.

Link copied to clipboard
data class GetContainerResult(val azureApiVersion: String, val containerStatus: String, val createdDateTime: String, val dataFormat: String, val id: String, val name: String, val refreshDetails: RefreshDetailsResponse, val systemData: SystemDataResponse, val type: String)

Represents a container on the Data Box Edge/Gateway device.

Link copied to clipboard
data class GetDeviceExtendedInformationResult(val channelIntegrityKeyName: String? = null, val channelIntegrityKeyVersion: String? = null, val clientSecretStoreId: String? = null, val clientSecretStoreUrl: String? = null, val cloudWitnessContainerName: String, val cloudWitnessStorageAccountName: String, val cloudWitnessStorageEndpoint: String, val clusterWitnessType: String, val deviceSecrets: Map<String, SecretResponse>, val encryptionKey: String? = null, val encryptionKeyThumbprint: String? = null, val fileShareWitnessLocation: String, val fileShareWitnessUsername: String, val id: String, val keyVaultSyncStatus: String? = null, val name: String, val resourceKey: String, val systemData: SystemDataResponse, val type: String)

The extended Info of the Data Box Edge/Gateway device.

Link copied to clipboard
data class GetDeviceResult(val azureApiVersion: String, val configuredRoleTypes: List<String>, val culture: String, val dataBoxEdgeDeviceStatus: String, val dataResidency: DataResidencyResponse? = null, val description: String, val deviceHcsVersion: String, val deviceLocalCapacity: Double, val deviceModel: String, val deviceSoftwareVersion: String, val deviceType: String, val edgeProfile: EdgeProfileResponse, val etag: String? = null, val friendlyName: String, val id: String, val identity: ResourceIdentityResponse? = null, val kind: String, val kubernetesWorkloadProfile: String, val location: String, val modelDescription: String, val name: String, val nodeCount: Int, val resourceMoveDetails: ResourceMoveDetailsResponse, val serialNumber: String, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val timeZone: String, val type: String)

The Data Box Edge/Gateway device.

Link copied to clipboard
data class GetFileEventTriggerResult(val azureApiVersion: String, val customContextTag: String? = null, val id: String, val kind: String, val name: String, val sinkInfo: RoleSinkInfoResponse, val sourceInfo: FileSourceInfoResponse, val systemData: SystemDataResponse, val type: String)

Trigger details.

Link copied to clipboard
data class GetIoTAddonResult(val azureApiVersion: String, val hostPlatform: String, val hostPlatformType: String, val id: String, val ioTDeviceDetails: IoTDeviceInfoResponse, val ioTEdgeDeviceDetails: IoTDeviceInfoResponse, val kind: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String, val version: String)

IoT Addon.

Link copied to clipboard
data class GetIoTRoleResult(val azureApiVersion: String, val computeResource: ComputeResourceResponse? = null, val hostPlatform: String, val hostPlatformType: String, val id: String, val ioTDeviceDetails: IoTDeviceInfoResponse, val ioTEdgeAgentInfo: IoTEdgeAgentInfoResponse? = null, val ioTEdgeDeviceDetails: IoTDeviceInfoResponse, val kind: String, val name: String, val roleStatus: String, val shareMappings: List<MountPointMapResponse>? = null, val systemData: SystemDataResponse, val type: String)

Compute role.

Link copied to clipboard
data class GetKubernetesRoleResult(val azureApiVersion: String, val hostPlatform: String, val hostPlatformType: String, val id: String, val kind: String, val kubernetesClusterInfo: KubernetesClusterInfoResponse, val kubernetesRoleResources: KubernetesRoleResourcesResponse, val name: String, val provisioningState: String, val roleStatus: String, val systemData: SystemDataResponse, val type: String)

The limited preview of Kubernetes Cluster Management from the Azure supports:

Link copied to clipboard
data class GetMECRoleResult(val azureApiVersion: String, val connectionString: AsymmetricEncryptedSecretResponse? = null, val controllerEndpoint: String? = null, val id: String, val kind: String, val name: String, val resourceUniqueId: String? = null, val roleStatus: String, val systemData: SystemDataResponse, val type: String)

MEC role.

Link copied to clipboard
data class GetMonitoringConfigResult(val azureApiVersion: String, val id: String, val metricConfigurations: List<MetricConfigurationResponse>, val name: String, val systemData: SystemDataResponse, val type: String)

The metric setting details for the role

Link copied to clipboard
data class GetOrderResult(val azureApiVersion: String, val contactInformation: ContactDetailsResponse, val currentStatus: OrderStatusResponse, val deliveryTrackingInfo: List<TrackingInfoResponse>, val id: String, val kind: String, val name: String, val orderHistory: List<OrderStatusResponse>, val orderId: String, val returnTrackingInfo: List<TrackingInfoResponse>, val serialNumber: String, val shipmentType: String? = null, val shippingAddress: AddressResponse? = null, val systemData: SystemDataResponse, val type: String)

The order details.

Link copied to clipboard
data class GetPeriodicTimerEventTriggerResult(val azureApiVersion: String, val customContextTag: String? = null, val id: String, val kind: String, val name: String, val sinkInfo: RoleSinkInfoResponse, val sourceInfo: PeriodicTimerSourceInfoResponse, val systemData: SystemDataResponse, val type: String)

Trigger details.

Link copied to clipboard
data class GetShareResult(val accessProtocol: String, val azureApiVersion: String, val azureContainerInfo: AzureContainerInfoResponse? = null, val clientAccessRights: List<ClientAccessRightResponse>? = null, val dataPolicy: String? = null, val description: String? = null, val id: String, val monitoringStatus: String, val name: String, val refreshDetails: RefreshDetailsResponse? = null, val shareMappings: List<MountPointMapResponse>, val shareStatus: String, val systemData: SystemDataResponse, val type: String, val userAccessRights: List<UserAccessRightResponse>? = null)

Represents a share on the Data Box Edge/Gateway device.

Link copied to clipboard
data class GetStorageAccountCredentialResult(val accountKey: AsymmetricEncryptedSecretResponse? = null, val accountType: String, val alias: String, val azureApiVersion: String, val blobDomainName: String? = null, val connectionString: String? = null, val id: String, val name: String, val sslStatus: String, val storageAccountId: String? = null, val systemData: SystemDataResponse, val type: String, val userName: String? = null)

The storage account credential.

Link copied to clipboard
data class GetStorageAccountResult(val azureApiVersion: String, val blobEndpoint: String, val containerCount: Int, val dataPolicy: String, val description: String? = null, val id: String, val name: String, val storageAccountCredentialId: String? = null, val storageAccountStatus: String? = null, val systemData: SystemDataResponse, val type: String)

Represents a Storage Account on the Data Box Edge/Gateway device.

Link copied to clipboard
data class GetUserResult(val azureApiVersion: String, val encryptedPassword: AsymmetricEncryptedSecretResponse? = null, val id: String, val name: String, val shareAccessRights: List<ShareAccessRightResponse>, val systemData: SystemDataResponse, val type: String, val userType: String)

Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.

Link copied to clipboard
data class ImageRepositoryCredentialResponse(val imageRepositoryUrl: String, val password: AsymmetricEncryptedSecretResponse? = null, val userName: String)

Image repository credential.

Link copied to clipboard
data class IoTDeviceInfoResponse(val authentication: AuthenticationResponse? = null, val deviceId: String, val ioTHostHub: String, val ioTHostHubId: String? = null)

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

Link copied to clipboard
data class IoTEdgeAgentInfoResponse(val imageName: String, val imageRepository: ImageRepositoryCredentialResponse? = null, val tag: String)

IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.

Link copied to clipboard
data class KubernetesClusterInfoResponse(val etcdInfo: EtcdInfoResponse, val nodes: List<NodeInfoResponse>, val version: String)

Kubernetes cluster configuration

Link copied to clipboard
data class KubernetesIPConfigurationResponse(val ipAddress: String? = null, val port: String)

Kubernetes node IP configuration

Link copied to clipboard
data class KubernetesRoleComputeResponse(val memoryInBytes: Double, val processorCount: Int, val vmProfile: String)

Kubernetes role compute resource

Link copied to clipboard
data class KubernetesRoleNetworkResponse(val cniConfig: CniConfigResponse, val loadBalancerConfig: LoadBalancerConfigResponse)

Kubernetes role network resource

Link copied to clipboard

Kubernetes role resources

Link copied to clipboard
data class KubernetesRoleStorageClassInfoResponse(val name: String, val posixCompliant: String, val type: String)

Kubernetes storage class info.

Link copied to clipboard

Kubernetes role storage resource

Link copied to clipboard
data class ListOrderDCAccessCodeResult(val authCode: String? = null)

DC Access code in the case of Self Managed Shipping.

Link copied to clipboard
data class LoadBalancerConfigResponse(val type: String, val version: String)

Load balancer configuration

Link copied to clipboard
data class MetricConfigurationResponse(val counterSets: List<MetricCounterSetResponse>, val mdmAccount: String? = null, val metricNameSpace: String? = null, val resourceId: String)

Metric configuration.

Link copied to clipboard
data class MetricCounterResponse(val additionalDimensions: List<MetricDimensionResponse>? = null, val dimensionFilter: List<MetricDimensionResponse>? = null, val instance: String? = null, val name: String)

The metric counter

Link copied to clipboard

The metric counter set

Link copied to clipboard
data class MetricDimensionResponse(val sourceName: String, val sourceType: String)

The metric dimension

Link copied to clipboard
data class MountPointMapResponse(val mountPoint: String, val mountType: String, val roleId: String, val roleType: String, val shareId: String)

The share mount point.

Link copied to clipboard
data class NodeInfoResponse(val ipConfiguration: List<KubernetesIPConfigurationResponse>? = null, val name: String, val type: String)

Kubernetes node info

Link copied to clipboard
data class OrderStatusResponse(val additionalOrderDetails: Map<String, String>, val comments: String? = null, val status: String, val trackingInformation: TrackingInfoResponse, val updateDateTime: String)

Represents a single status change.

Link copied to clipboard
data class PeriodicTimerSourceInfoResponse(val schedule: String, val startTime: String, val topic: String? = null)

Periodic timer event source.

Link copied to clipboard
data class RefreshDetailsResponse(val errorManifestFile: String? = null, val inProgressRefreshJobId: String? = null, val lastCompletedRefreshJobTimeInUTC: String? = null, val lastJob: String? = null)

Fields for tracking refresh job on the share or container.

Link copied to clipboard
data class ResourceIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Msi identity details of the resource

Link copied to clipboard
data class ResourceMoveDetailsResponse(val operationInProgress: String? = null, val operationInProgressLockTimeoutInUTC: String? = null)

Fields for tracking resource move

Link copied to clipboard
data class RoleSinkInfoResponse(val roleId: String)

Compute role against which events will be raised.

Link copied to clipboard
data class SecretResponse(val encryptedSecret: AsymmetricEncryptedSecretResponse? = null, val keyVaultId: String? = null)

Holds device secret either as a KeyVault reference or as an encrypted value.

Link copied to clipboard
data class ShareAccessRightResponse(val accessType: String, val shareId: String)

Specifies the mapping between this particular user and the type of access he has on shares on this device.

Link copied to clipboard
data class SkuResponse(val name: String? = null, val tier: String? = null)

The SKU type.

Link copied to clipboard
data class SubscriptionRegisteredFeaturesResponse(val name: String? = null, val state: String? = null)
Link copied to clipboard
data class SymmetricKeyResponse(val connectionString: AsymmetricEncryptedSecretResponse? = null)

Symmetric key for authentication.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TrackingInfoResponse(val carrierName: String? = null, val serialNumber: String? = null, val trackingId: String? = null, val trackingUrl: String? = null)

Tracking courier information.

Link copied to clipboard
data class UserAccessRightResponse(val accessType: String, val userId: String)

The mapping between a particular user and the access type on the SMB share.