Package-level declarations

Types

Link copied to clipboard
class ArcAddon : KotlinCustomResource

Arc Addon. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class ArcAddonArgs(val addonName: Output<String>? = null, val deviceName: Output<String>? = null, val kind: Output<String>? = null, val resourceGroupName: Output<String>? = null, val resourceLocation: Output<String>? = null, val resourceName: Output<String>? = null, val roleName: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<ArcAddonArgs>

Arc Addon. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
Link copied to clipboard
object ArcAddonMapper : ResourceMapper<ArcAddon>
Link copied to clipboard
Link copied to clipboard
class BandwidthSchedule : KotlinCustomResource

The bandwidth schedule details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class BandwidthScheduleArgs(val days: Output<List<Either<String, DayOfWeek>>>? = null, val deviceName: Output<String>? = null, val name: Output<String>? = null, val rateInMbps: Output<Int>? = null, val resourceGroupName: Output<String>? = null, val start: Output<String>? = null, val stop: Output<String>? = null) : ConvertibleToJava<BandwidthScheduleArgs>

The bandwidth schedule details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
object BandwidthScheduleMapper : ResourceMapper<BandwidthSchedule>
Link copied to clipboard
class CloudEdgeManagementRole : KotlinCustomResource

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. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class CloudEdgeManagementRoleArgs(val deviceName: Output<String>? = null, val kind: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val roleStatus: Output<Either<String, RoleStatus>>? = null) : ConvertibleToJava<CloudEdgeManagementRoleArgs>

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. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
Link copied to clipboard
class Container : KotlinCustomResource

Represents a container on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class ContainerArgs(val containerName: Output<String>? = null, val dataFormat: Output<Either<String, AzureContainerDataFormat>>? = null, val deviceName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val storageAccountName: Output<String>? = null) : ConvertibleToJava<ContainerArgs>

Represents a container on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
Link copied to clipboard
object ContainerMapper : ResourceMapper<Container>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Device : KotlinCustomResource

The Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2021-02-01, 2021-02-01-preview, 2022-04-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class DeviceArgs(val dataResidency: Output<DataResidencyArgs>? = null, val deviceName: Output<String>? = null, val identity: Output<ResourceIdentityArgs>? = null, val location: Output<String>? = null, val resourceGroupName: Output<String>? = null, val sku: Output<SkuArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<DeviceArgs>

The Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2021-02-01, 2021-02-01-preview, 2022-04-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard

Builder for DeviceArgs.

Link copied to clipboard
object DeviceMapper : ResourceMapper<Device>
Link copied to clipboard

Builder for Device.

Link copied to clipboard
class FileEventTrigger : KotlinCustomResource

Trigger details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class FileEventTriggerArgs(val customContextTag: Output<String>? = null, val deviceName: Output<String>? = null, val kind: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val sinkInfo: Output<RoleSinkInfoArgs>? = null, val sourceInfo: Output<FileSourceInfoArgs>? = null) : ConvertibleToJava<FileEventTriggerArgs>

Trigger details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
object FileEventTriggerMapper : ResourceMapper<FileEventTrigger>
Link copied to clipboard
class IoTAddon : KotlinCustomResource

IoT Addon. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class IoTAddonArgs(val addonName: Output<String>? = null, val deviceName: Output<String>? = null, val ioTDeviceDetails: Output<IoTDeviceInfoArgs>? = null, val ioTEdgeDeviceDetails: Output<IoTDeviceInfoArgs>? = null, val kind: Output<String>? = null, val resourceGroupName: Output<String>? = null, val roleName: Output<String>? = null) : ConvertibleToJava<IoTAddonArgs>

IoT Addon. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
Link copied to clipboard
object IoTAddonMapper : ResourceMapper<IoTAddon>
Link copied to clipboard
Link copied to clipboard
class IoTRole : KotlinCustomResource

Compute role. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class IoTRoleArgs(val computeResource: Output<ComputeResourceArgs>? = null, val deviceName: Output<String>? = null, val hostPlatform: Output<Either<String, PlatformType>>? = null, val ioTDeviceDetails: Output<IoTDeviceInfoArgs>? = null, val ioTEdgeAgentInfo: Output<IoTEdgeAgentInfoArgs>? = null, val ioTEdgeDeviceDetails: Output<IoTDeviceInfoArgs>? = null, val kind: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val roleStatus: Output<Either<String, RoleStatus>>? = null, val shareMappings: Output<List<MountPointMapArgs>>? = null) : ConvertibleToJava<IoTRoleArgs>

Compute role. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
Link copied to clipboard
object IoTRoleMapper : ResourceMapper<IoTRole>
Link copied to clipboard
Link copied to clipboard
class KubernetesRole : KotlinCustomResource

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

Link copied to clipboard
data class KubernetesRoleArgs(val deviceName: Output<String>? = null, val hostPlatform: Output<Either<String, PlatformType>>? = null, val kind: Output<String>? = null, val kubernetesClusterInfo: Output<KubernetesClusterInfoArgs>? = null, val kubernetesRoleResources: Output<KubernetesRoleResourcesArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val roleStatus: Output<Either<String, RoleStatus>>? = null) : ConvertibleToJava<KubernetesRoleArgs>

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

Link copied to clipboard
Link copied to clipboard
object KubernetesRoleMapper : ResourceMapper<KubernetesRole>
Link copied to clipboard
class MECRole : KotlinCustomResource

MEC role. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class MECRoleArgs(val connectionString: Output<AsymmetricEncryptedSecretArgs>? = null, val controllerEndpoint: Output<String>? = null, val deviceName: Output<String>? = null, val kind: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val resourceUniqueId: Output<String>? = null, val roleStatus: Output<Either<String, RoleStatus>>? = null) : ConvertibleToJava<MECRoleArgs>

MEC role. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
Link copied to clipboard
object MECRoleMapper : ResourceMapper<MECRole>
Link copied to clipboard
Link copied to clipboard
class MonitoringConfig : KotlinCustomResource

The metric setting details for the role Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class MonitoringConfigArgs(val deviceName: Output<String>? = null, val metricConfigurations: Output<List<MetricConfigurationArgs>>? = null, val resourceGroupName: Output<String>? = null, val roleName: Output<String>? = null) : ConvertibleToJava<MonitoringConfigArgs>

The metric setting details for the role Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
object MonitoringConfigMapper : ResourceMapper<MonitoringConfig>
Link copied to clipboard
class Order : KotlinCustomResource

The order details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2022-04-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class OrderArgs(val contactInformation: Output<ContactDetailsArgs>? = null, val deviceName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val shipmentType: Output<Either<String, ShipmentType>>? = null, val shippingAddress: Output<AddressArgs>? = null) : ConvertibleToJava<OrderArgs>

The order details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2022-04-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard

Builder for OrderArgs.

Link copied to clipboard
object OrderMapper : ResourceMapper<Order>
Link copied to clipboard

Builder for Order.

Link copied to clipboard
class PeriodicTimerEventTrigger : KotlinCustomResource

Trigger details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
data class PeriodicTimerEventTriggerArgs(val customContextTag: Output<String>? = null, val deviceName: Output<String>? = null, val kind: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val sinkInfo: Output<RoleSinkInfoArgs>? = null, val sourceInfo: Output<PeriodicTimerSourceInfoArgs>? = null) : ConvertibleToJava<PeriodicTimerEventTriggerArgs>

Trigger details. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01.

Link copied to clipboard
class Share : KotlinCustomResource

Represents a share on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class ShareArgs(val accessProtocol: Output<Either<String, ShareAccessProtocol>>? = null, val azureContainerInfo: Output<AzureContainerInfoArgs>? = null, val clientAccessRights: Output<List<ClientAccessRightArgs>>? = null, val dataPolicy: Output<Either<String, DataPolicy>>? = null, val description: Output<String>? = null, val deviceName: Output<String>? = null, val monitoringStatus: Output<Either<String, MonitoringStatus>>? = null, val name: Output<String>? = null, val refreshDetails: Output<RefreshDetailsArgs>? = null, val resourceGroupName: Output<String>? = null, val shareStatus: Output<Either<String, ShareStatus>>? = null, val userAccessRights: Output<List<UserAccessRightArgs>>? = null) : ConvertibleToJava<ShareArgs>

Represents a share on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard

Builder for ShareArgs.

Link copied to clipboard
object ShareMapper : ResourceMapper<Share>
Link copied to clipboard

Builder for Share.

Link copied to clipboard
class StorageAccount : KotlinCustomResource

Represents a Storage Account on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class StorageAccountArgs(val dataPolicy: Output<Either<String, DataPolicy>>? = null, val description: Output<String>? = null, val deviceName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val storageAccountCredentialId: Output<String>? = null, val storageAccountName: Output<String>? = null, val storageAccountStatus: Output<Either<String, StorageAccountStatus>>? = null) : ConvertibleToJava<StorageAccountArgs>

Represents a Storage Account on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
Link copied to clipboard
class StorageAccountCredential : KotlinCustomResource

The storage account credential. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class StorageAccountCredentialArgs(val accountKey: Output<AsymmetricEncryptedSecretArgs>? = null, val accountType: Output<Either<String, AccountType>>? = null, val alias: Output<String>? = null, val blobDomainName: Output<String>? = null, val connectionString: Output<String>? = null, val deviceName: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val sslStatus: Output<Either<String, SSLStatus>>? = null, val storageAccountId: Output<String>? = null, val userName: Output<String>? = null) : ConvertibleToJava<StorageAccountCredentialArgs>

The storage account credential. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
object StorageAccountMapper : ResourceMapper<StorageAccount>
Link copied to clipboard
class User : KotlinCustomResource

Represents a user who has access to one or more shares on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2021-02-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard
data class UserArgs(val deviceName: Output<String>? = null, val encryptedPassword: Output<AsymmetricEncryptedSecretArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val userType: Output<Either<String, UserType>>? = null) : ConvertibleToJava<UserArgs>

Represents a user who has access to one or more shares on the Data Box Edge/Gateway device. Uses Azure REST API version 2022-03-01. In version 1.x of the Azure Native provider, it used API version 2020-12-01. Other available API versions: 2021-02-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Link copied to clipboard

Builder for UserArgs.

Link copied to clipboard
object UserMapper : ResourceMapper<User>
Link copied to clipboard

Builder for User.

Functions

Link copied to clipboard
suspend fun arcAddon(name: String, block: suspend ArcAddonResourceBuilder.() -> Unit): ArcAddon
Link copied to clipboard
suspend fun container(name: String, block: suspend ContainerResourceBuilder.() -> Unit): Container
Link copied to clipboard
fun device(name: String): Device
suspend fun device(name: String, block: suspend DeviceResourceBuilder.() -> Unit): Device
Link copied to clipboard
Link copied to clipboard
suspend fun ioTAddon(name: String, block: suspend IoTAddonResourceBuilder.() -> Unit): IoTAddon
Link copied to clipboard
fun ioTRole(name: String): IoTRole
suspend fun ioTRole(name: String, block: suspend IoTRoleResourceBuilder.() -> Unit): IoTRole
Link copied to clipboard
Link copied to clipboard
fun mecRole(name: String): MECRole
suspend fun mecRole(name: String, block: suspend MECRoleResourceBuilder.() -> Unit): MECRole
Link copied to clipboard
Link copied to clipboard
fun order(name: String): Order
suspend fun order(name: String, block: suspend OrderResourceBuilder.() -> Unit): Order
Link copied to clipboard
fun share(name: String): Share
suspend fun share(name: String, block: suspend ShareResourceBuilder.() -> Unit): Share
Link copied to clipboard
Link copied to clipboard
fun user(name: String): User
suspend fun user(name: String, block: suspend UserResourceBuilder.() -> Unit): User