Package-level declarations

Types

Link copied to clipboard
data class BlobNfsTargetResponse(val target: String? = null, val usageModel: String? = 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, 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)

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)

Cache identity properties.

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 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 GetCacheResult(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 provisioningState: String? = null, val securitySettings: CacheSecuritySettingsResponse? = null, val sku: CacheResponseSku? = null, val subnet: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val upgradeStatus: CacheUpgradeStatusResponse? = 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 GetStorageTargetResult(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? = 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)

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 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