Package-level declarations

Types

Link copied to clipboard
data class ApplicationGetEndpointResponse(val destinationPort: Int? = null, val location: String? = null, val privateIPAddress: String? = null, val publicPort: Int? = null)

Gets the application SSH endpoint

Link copied to clipboard
data class ApplicationGetHttpsEndpointResponse(val accessModes: List<String>? = null, val destinationPort: Int? = null, val disableGatewayAuth: Boolean? = null, val location: String, val privateIPAddress: String? = null, val publicPort: Int, val subDomainSuffix: String? = null)

Gets the application HTTP endpoints.

Link copied to clipboard
data class ApplicationPropertiesResponse(val applicationState: String, val applicationType: String? = null, val computeProfile: ComputeProfileResponse? = null, val createdDate: String, val errors: List<ErrorsResponse>? = null, val httpsEndpoints: List<ApplicationGetHttpsEndpointResponse>? = null, val installScriptActions: List<RuntimeScriptActionResponse>? = null, val marketplaceIdentifier: String, val provisioningState: String, val sshEndpoints: List<ApplicationGetEndpointResponse>? = null, val uninstallScriptActions: List<RuntimeScriptActionResponse>? = null)

The HDInsight cluster application GET response.

Link copied to clipboard
data class AutoscaleCapacityResponse(val maxInstanceCount: Int? = null, val minInstanceCount: Int? = null)

The load-based autoscale request parameters

Link copied to clipboard
data class AutoscaleRecurrenceResponse(val schedule: List<AutoscaleScheduleResponse>? = null, val timeZone: String? = null)

Schedule-based autoscale request parameters

Link copied to clipboard
data class AutoscaleResponse(val capacity: AutoscaleCapacityResponse? = null, val recurrence: AutoscaleRecurrenceResponse? = null)

The autoscale request parameters

Link copied to clipboard
data class AutoscaleScheduleResponse(val days: List<String>? = null, val timeAndCapacity: AutoscaleTimeAndCapacityResponse? = null)

Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity

Link copied to clipboard
data class AutoscaleTimeAndCapacityResponse(val maxInstanceCount: Int? = null, val minInstanceCount: Int? = null, val time: String? = null)

Time and capacity request parameters

Link copied to clipboard
data class ClientGroupInfoResponse(val groupId: String? = null, val groupName: String? = null)

The information of AAD security group.

Link copied to clipboard
data class ClusterDefinitionResponse(val blueprint: String? = null, val componentVersion: Map<String, String>? = null, val configurations: Any? = null, val kind: String? = null)

The cluster definition.

Link copied to clipboard
data class ClusterGetPropertiesResponse(val clusterDefinition: ClusterDefinitionResponse, val clusterHdpVersion: String? = null, val clusterId: String? = null, val clusterState: String? = null, val clusterVersion: String? = null, val computeIsolationProperties: ComputeIsolationPropertiesResponse? = null, val computeProfile: ComputeProfileResponse? = null, val connectivityEndpoints: List<ConnectivityEndpointResponse>? = null, val createdDate: String? = null, val diskEncryptionProperties: DiskEncryptionPropertiesResponse? = null, val encryptionInTransitProperties: EncryptionInTransitPropertiesResponse? = null, val errors: List<ErrorsResponse>? = null, val excludedServicesConfig: ExcludedServicesConfigResponse? = null, val kafkaRestProperties: KafkaRestPropertiesResponse? = null, val minSupportedTlsVersion: String? = null, val networkProperties: NetworkPropertiesResponse? = null, val osType: String? = null, val provisioningState: String? = null, val quotaInfo: QuotaInfoResponse? = null, val securityProfile: SecurityProfileResponse? = null, val storageProfile: StorageProfileResponse? = null, val tier: String? = null)

The properties of cluster.

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

Identity for the cluster.

data class ClusterIdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String, val tenantId: String? = null)
Link copied to clipboard
data class ComputeIsolationPropertiesResponse(val enableComputeIsolation: Boolean? = null, val hostSku: String? = null)

The compute isolation properties.

Link copied to clipboard
data class ComputeProfileResponse(val roles: List<RoleResponse>? = null)

Describes the compute profile.

Link copied to clipboard
data class ConnectivityEndpointResponse(val location: String? = null, val name: String? = null, val port: Int? = null, val privateIPAddress: String? = null, val protocol: String? = null)

The connectivity properties

Link copied to clipboard
data class DataDisksGroupsResponse(val diskSizeGB: Int, val disksPerNode: Int? = null, val storageAccountType: String)

The data disks groups for the role.

Link copied to clipboard
data class DiskEncryptionPropertiesResponse(val encryptionAlgorithm: String? = null, val encryptionAtHost: Boolean? = null, val keyName: String? = null, val keyVersion: String? = null, val msiResourceId: String? = null, val vaultUri: String? = null)

The disk encryption properties

Link copied to clipboard
data class EncryptionInTransitPropertiesResponse(val isEncryptionInTransitEnabled: Boolean? = null)

The encryption-in-transit properties.

Link copied to clipboard
data class ErrorsResponse(val code: String? = null, val message: String? = null)

The error message associated with the cluster creation.

Link copied to clipboard
data class ExcludedServicesConfigResponse(val excludedServicesConfigId: String? = null, val excludedServicesList: String? = null)

The configuration that services will be excluded when creating cluster.

Link copied to clipboard
data class GetApplicationResult(val etag: String? = null, val id: String, val name: String, val properties: ApplicationPropertiesResponse, val tags: Map<String, String>? = null, val type: String)

The HDInsight cluster application

Link copied to clipboard
data class GetClusterGatewaySettingsResult(val isCredentialEnabled: String, val password: String, val userName: String)

Gateway settings.

Link copied to clipboard
data class GetClusterResult(val etag: String? = null, val id: String, val identity: ClusterIdentityResponse? = null, val location: String? = null, val name: String, val properties: ClusterGetPropertiesResponse, val tags: Map<String, String>? = null, val type: String)

The HDInsight cluster.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val id: String, val linkIdentifier: String, val name: String, val privateEndpoint: PrivateEndpointResponse, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The private endpoint connection.

Link copied to clipboard
data class HardwareProfileResponse(val vmSize: String? = null)

The hardware profile.

Link copied to clipboard
data class KafkaRestPropertiesResponse(val clientGroupInfo: ClientGroupInfoResponse? = null, val configurationOverride: Map<String, String>? = null)

The kafka rest proxy configuration which contains AAD security group information.

Link copied to clipboard
data class LinuxOperatingSystemProfileResponse(val password: String? = null, val sshProfile: SshProfileResponse? = null, val username: String? = null)

The ssh username, password, and ssh public key.

Link copied to clipboard
data class NetworkPropertiesResponse(val privateLink: String? = null, val resourceProviderConnection: String? = null)

The network properties.

Link copied to clipboard
data class OsProfileResponse(val linuxOperatingSystemProfile: LinuxOperatingSystemProfileResponse? = null)

The Linux operation systems profile.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String? = null)

The private endpoint.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String)

The private link service connection state.

Link copied to clipboard
data class QuotaInfoResponse(val coresUsed: Int? = null)

The quota properties for the cluster.

Link copied to clipboard
data class RoleResponse(val autoscaleConfiguration: AutoscaleResponse? = null, val dataDisksGroups: List<DataDisksGroupsResponse>? = null, val encryptDataDisks: Boolean? = null, val hardwareProfile: HardwareProfileResponse? = null, val minInstanceCount: Int? = null, val name: String? = null, val osProfile: OsProfileResponse? = null, val scriptActions: List<ScriptActionResponse>? = null, val targetInstanceCount: Int? = null, val vMGroupName: String? = null, val virtualNetworkProfile: VirtualNetworkProfileResponse? = null)

Describes a role on the cluster.

Link copied to clipboard
data class RuntimeScriptActionResponse(val applicationName: String, val name: String, val parameters: String? = null, val roles: List<String>, val uri: String)

Describes a script action on a running cluster.

Link copied to clipboard
data class ScriptActionResponse(val name: String, val parameters: String, val uri: String)

Describes a script action on role on the cluster.

Link copied to clipboard
data class SecurityProfileResponse(val aaddsResourceId: String? = null, val clusterUsersGroupDNs: List<String>? = null, val directoryType: String? = null, val domain: String? = null, val domainUserPassword: String? = null, val domainUsername: String? = null, val ldapsUrls: List<String>? = null, val msiResourceId: String? = null, val organizationalUnitDN: String? = null)

The security profile which contains Ssh public key for the HDInsight cluster.

Link copied to clipboard
data class SshProfileResponse(val publicKeys: List<SshPublicKeyResponse>? = null)

The list of SSH public keys.

Link copied to clipboard
data class SshPublicKeyResponse(val certificateData: String? = null)

The SSH public key for the cluster nodes.

Link copied to clipboard
data class StorageAccountResponse(val container: String? = null, val fileSystem: String? = null, val fileshare: String? = null, val isDefault: Boolean? = null, val key: String? = null, val msiResourceId: String? = null, val name: String? = null, val resourceId: String? = null, val saskey: String? = null)

The storage Account.

Link copied to clipboard
data class StorageProfileResponse(val storageaccounts: List<StorageAccountResponse>? = null)

The storage profile.

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 VirtualNetworkProfileResponse(val id: String? = null, val subnet: String? = null)

The virtual network properties.