Package-level declarations

Types

Link copied to clipboard
data class AmlFilesystemArchiveResponse(val filesystemPath: String, val status: AmlFilesystemArchiveResponseStatus)

Information about the AML file system archive

Link copied to clipboard
data class AmlFilesystemArchiveResponseStatus(val errorCode: String, val errorMessage: String, val lastCompletionTime: String, val lastStartedTime: String, val percentComplete: Int, val state: String)

The status of the archive

Link copied to clipboard
data class AmlFilesystemClientInfoResponse(val containerStorageInterface: AmlFilesystemContainerStorageInterfaceResponse, val lustreVersion: String, val mgsAddress: String, val mountCommand: String)

AML file system client information

data class AmlFilesystemContainerStorageInterfaceResponse(val persistentVolume: String, val persistentVolumeClaim: String, val storageClass: String)

AML file system container storage interface information

Link copied to clipboard

AML file system encryption settings.

Link copied to clipboard
data class AmlFilesystemHealthResponse(val state: String? = null, val statusCode: String? = null, val statusDescription: String? = null)

An indication of AML file system health. Gives more information about health than just that related to provisioning.

Link copied to clipboard
data class AmlFilesystemHsmSettingsResponse(val container: String, val importPrefix: String? = null, val importPrefixesInitial: List<String>? = null, val loggingContainer: String)

AML file system HSM settings.

Link copied to clipboard
data class AmlFilesystemIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentitiesResponseUserAssignedIdentities>? = null)

Managed Identity properties.

Link copied to clipboard

Hydration and archive settings and status

Link copied to clipboard
data class AmlFilesystemResponseMaintenanceWindow(val dayOfWeek: String? = null, val timeOfDayUTC: String? = null)

Start time of a 30-minute weekly maintenance window.

Link copied to clipboard
data class AmlFilesystemRootSquashSettingsResponse(val mode: String? = null, val noSquashNidLists: String? = null, val squashGID: Double? = null, val squashUID: Double? = null, val status: String)

AML file system squash settings.

Link copied to clipboard
data class BlobNfsTargetResponse(val target: String? = null, val usageModel: String? = null, val verificationTimer: Int? = null, val writeBackTimer: Int? = null)

Properties pertaining to the BlobNfsTarget.

Link copied to clipboard
data class CacheActiveDirectorySettingsResponse(val cacheNetBiosName: String, val credentials: CacheActiveDirectorySettingsResponseCredentials? = null, val domainJoined: String, val domainName: String, val domainNetBiosName: String, val primaryDnsIpAddress: String, val secondaryDnsIpAddress: String? = null)

Active Directory settings used to join a cache to a domain.

data class CacheActiveDirectorySettingsResponseCredentials(val password: String? = null, val username: String)

Active Directory admin credentials used to join the HPC Cache to a domain.

Link copied to clipboard
data class CacheDirectorySettingsResponse(val activeDirectory: CacheActiveDirectorySettingsResponse? = null, val usernameDownload: CacheUsernameDownloadSettingsResponse? = null)

Cache Directory Services settings.

Link copied to clipboard
data class CacheEncryptionSettingsResponse(val keyEncryptionKey: KeyVaultKeyReferenceResponse? = null, val rotationToLatestKeyVersionEnabled: Boolean? = null)

Cache encryption settings.

Link copied to clipboard
data class CacheHealthResponse(val conditions: List<ConditionResponse>, val state: String? = null, val statusDescription: String? = null)

An indication of cache health. Gives more information about health than just that related to provisioning.

Link copied to clipboard
data class CacheIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, CacheIdentityResponseUserAssignedIdentities>? = null)

Cache identity properties.

data class CacheIdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)
Link copied to clipboard
data class CacheNetworkSettingsResponse(val dnsSearchDomain: String? = null, val dnsServers: List<String>? = null, val mtu: Int? = null, val ntpServer: String? = null, val utilityAddresses: List<String>)

Cache network settings.

Link copied to clipboard
data class CacheResponseSku(val name: String? = null)

SKU for the cache.

Link copied to clipboard
data class CacheSecuritySettingsResponse(val accessPolicies: List<NfsAccessPolicyResponse>? = null)

Cache security settings.

Link copied to clipboard
data class CacheUpgradeSettingsResponse(val scheduledTime: String? = null, val upgradeScheduleEnabled: Boolean? = null)

Cache Upgrade Settings.

Link copied to clipboard
data class CacheUpgradeStatusResponse(val currentFirmwareVersion: String, val firmwareUpdateDeadline: String, val firmwareUpdateStatus: String, val lastFirmwareUpdate: String, val pendingFirmwareVersion: String)

Properties describing the software upgrade state of the cache.

Link copied to clipboard
data class CacheUsernameDownloadSettingsResponse(val autoDownloadCertificate: Boolean? = null, val caCertificateURI: String? = null, val credentials: CacheUsernameDownloadSettingsResponseCredentials? = null, val encryptLdapConnection: Boolean? = null, val extendedGroups: Boolean? = null, val groupFileURI: String? = null, val ldapBaseDN: String? = null, val ldapServer: String? = null, val requireValidCertificate: Boolean? = null, val userFileURI: String? = null, val usernameDownloaded: String, val usernameSource: String? = null)

Settings for Extended Groups username and group download.

data class CacheUsernameDownloadSettingsResponseCredentials(val bindDn: String? = null, val bindPassword: String? = null)

When present, these are the credentials for the secure LDAP connection.

Link copied to clipboard
data class ClfsTargetResponse(val target: String? = null)

Properties pertaining to the ClfsTarget

Link copied to clipboard
data class ConditionResponse(val message: String, val timestamp: String)

Outstanding conditions that will need to be resolved.

Link copied to clipboard
data class GetAmlFilesystemResult(val azureApiVersion: String, val clientInfo: AmlFilesystemClientInfoResponse, val encryptionSettings: AmlFilesystemEncryptionSettingsResponse? = null, val filesystemSubnet: String, val health: AmlFilesystemHealthResponse, val hsm: AmlFilesystemResponseHsm? = null, val id: String, val identity: AmlFilesystemIdentityResponse? = null, val location: String, val maintenanceWindow: AmlFilesystemResponseMaintenanceWindow, val name: String, val provisioningState: String, val rootSquashSettings: AmlFilesystemRootSquashSettingsResponse? = null, val sku: SkuNameResponse? = null, val storageCapacityTiB: Double, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val throughputProvisionedMBps: Int, val type: String, val zones: List<String>? = null)

An AML file system instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Link copied to clipboard
data class GetAutoExportJobResult(val adminStatus: String? = null, val autoExportPrefixes: List<String>? = null, val azureApiVersion: String, val currentIterationFilesDiscovered: Double, val currentIterationFilesExported: Double, val currentIterationFilesFailed: Double, val currentIterationMiBDiscovered: Double, val currentIterationMiBExported: Double, val exportIterationCount: Int, val id: String, val lastCompletionTimeUTC: String, val lastStartedTimeUTC: String, val lastSuccessfulIterationCompletionTimeUTC: String, val location: String, val name: String, val provisioningState: String, val state: String? = null, val statusCode: String, val statusMessage: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val totalFilesExported: Double, val totalFilesFailed: Double, val totalMiBExported: Double, val type: String)

An auto export job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Link copied to clipboard
data class GetCacheResult(val azureApiVersion: String, val cacheSizeGB: Int? = null, val directoryServicesSettings: CacheDirectorySettingsResponse? = null, val encryptionSettings: CacheEncryptionSettingsResponse? = null, val health: CacheHealthResponse, val id: String, val identity: CacheIdentityResponse? = null, val location: String? = null, val mountAddresses: List<String>, val name: String, val networkSettings: CacheNetworkSettingsResponse? = null, val primingJobs: List<PrimingJobResponse>, val provisioningState: String, val securitySettings: CacheSecuritySettingsResponse? = null, val sku: CacheResponseSku? = null, val spaceAllocation: List<StorageTargetSpaceAllocationResponse>, val subnet: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val upgradeSettings: CacheUpgradeSettingsResponse? = null, val upgradeStatus: CacheUpgradeStatusResponse, val zones: List<String>? = null)

A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Link copied to clipboard
data class GetImportJobResult(val azureApiVersion: String, val blobsImportedPerSecond: Double, val blobsWalkedPerSecond: Double, val conflictResolutionMode: String? = null, val id: String, val importPrefixes: List<String>? = null, val lastCompletionTime: String, val lastStartedTime: String, val location: String, val maximumErrors: Int? = null, val name: String, val provisioningState: String, val state: String, val statusMessage: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val totalBlobsImported: Double, val totalBlobsWalked: Double, val totalConflicts: Int, val totalErrors: Int, val type: String)

An import job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Link copied to clipboard
data class GetRequiredAmlFSSubnetsSizeResult(val filesystemSubnetSize: Int? = null)

Information about the number of available IP addresses that are required for the AML file system.

Link copied to clipboard
data class GetStorageTargetResult(val allocationPercentage: Int, val azureApiVersion: String, val blobNfs: BlobNfsTargetResponse? = null, val clfs: ClfsTargetResponse? = null, val id: String, val junctions: List<NamespaceJunctionResponse>? = null, val location: String, val name: String, val nfs3: Nfs3TargetResponse? = null, val provisioningState: String, val state: String? = null, val systemData: SystemDataResponse, val targetType: String, val type: String, val unknown: UnknownTargetResponse? = null)

Type of the Storage Target.

Link copied to clipboard

Describes a reference to key vault key.

Link copied to clipboard

Describes a resource Id to source key vault.

Link copied to clipboard
data class NamespaceJunctionResponse(val namespacePath: String? = null, val nfsAccessPolicy: String? = null, val nfsExport: String? = null, val targetPath: String? = null)

A namespace junction.

Link copied to clipboard
data class Nfs3TargetResponse(val target: String? = null, val usageModel: String? = null, val verificationTimer: Int? = null, val writeBackTimer: Int? = null)

Properties pertaining to the Nfs3Target

Link copied to clipboard
data class NfsAccessPolicyResponse(val accessRules: List<NfsAccessRuleResponse>, val name: String)

A set of rules describing access policies applied to NFSv3 clients of the cache.

Link copied to clipboard
data class NfsAccessRuleResponse(val access: String, val anonymousGID: String? = null, val anonymousUID: String? = null, val filter: String? = null, val rootSquash: Boolean? = null, val scope: String, val submountAccess: Boolean? = null, val suid: Boolean? = null)

Rule to place restrictions on portions of the cache namespace being presented to clients.

Link copied to clipboard
data class PrimingJobResponse(val primingJobDetails: String, val primingJobId: String, val primingJobName: String, val primingJobPercentComplete: Double, val primingJobState: String, val primingJobStatus: String)

A priming job instance.

Link copied to clipboard
data class SkuNameResponse(val name: String? = null)

SKU for the resource.

Link copied to clipboard
data class StorageTargetSpaceAllocationResponse(val allocationPercentage: Int? = null, val name: String? = null)

Storage Target space allocation properties.

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 UnknownTargetResponse(val attributes: Map<String, String>? = null)

Properties pertaining to the UnknownTarget