Package-level declarations

Types

Link copied to clipboard
data class GetApplicationGroupResult(val applicationGroupType: String, val cloudPcResource: Boolean, val description: String? = null, val etag: String, val friendlyName: String? = null, val hostPoolArmPath: String, val id: String, val identity: ResourceModelWithAllowedPropertySetResponseIdentity? = null, val kind: String? = null, val location: String? = null, val managedBy: String? = null, val migrationRequest: MigrationRequestPropertiesResponse? = null, val name: String, val objectId: String, val plan: ResourceModelWithAllowedPropertySetResponsePlan? = null, val sku: ResourceModelWithAllowedPropertySetResponseSku? = null, val tags: Map<String, String>? = null, val type: String, val workspaceArmPath: String)

Represents a ApplicationGroup definition.

Link copied to clipboard
data class GetApplicationResult(val applicationType: String? = null, val commandLineArguments: String? = null, val commandLineSetting: String, val description: String? = null, val filePath: String? = null, val friendlyName: String? = null, val iconContent: String, val iconHash: String, val iconIndex: Int? = null, val iconPath: String? = null, val id: String, val msixPackageApplicationId: String? = null, val msixPackageFamilyName: String? = null, val name: String, val objectId: String, val showInPortal: Boolean? = null, val type: String)

Schema for Application properties.

Link copied to clipboard
data class GetHostPoolResult(val applicationGroupReferences: List<String>, val cloudPcResource: Boolean, val customRdpProperty: String? = null, val description: String? = null, val etag: String, val friendlyName: String? = null, val hostPoolType: String, val id: String, val identity: ResourceModelWithAllowedPropertySetResponseIdentity? = null, val kind: String? = null, val loadBalancerType: String, val location: String? = null, val managedBy: String? = null, val maxSessionLimit: Int? = null, val migrationRequest: MigrationRequestPropertiesResponse? = null, val name: String, val objectId: String, val personalDesktopAssignmentType: String? = null, val plan: ResourceModelWithAllowedPropertySetResponsePlan? = null, val preferredAppGroupType: String, val registrationInfo: RegistrationInfoResponse? = null, val ring: Int? = null, val sku: ResourceModelWithAllowedPropertySetResponseSku? = null, val ssoClientId: String? = null, val ssoClientSecretKeyVaultPath: String? = null, val ssoSecretType: String? = null, val ssoadfsAuthority: String? = null, val startVMOnConnect: Boolean? = null, val tags: Map<String, String>? = null, val type: String, val validationEnvironment: Boolean? = null, val vmTemplate: String? = null)

Represents a HostPool definition.

Link copied to clipboard
data class GetMSIXPackageResult(val displayName: String? = null, val id: String, val imagePath: String? = null, val isActive: Boolean? = null, val isRegularRegistration: Boolean? = null, val lastUpdated: String? = null, val name: String, val packageApplications: List<MsixPackageApplicationsResponse>? = null, val packageDependencies: List<MsixPackageDependenciesResponse>? = null, val packageFamilyName: String? = null, val packageName: String? = null, val packageRelativePath: String? = null, val type: String, val version: String? = null)

Schema for MSIX Package properties.

data class GetPrivateEndpointConnectionByHostPoolResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

data class GetPrivateEndpointConnectionByWorkspaceResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetScalingPlanPooledScheduleResult(val daysOfWeek: List<String>? = null, val id: String, val name: String, val offPeakLoadBalancingAlgorithm: String? = null, val offPeakStartTime: TimeResponse? = null, val peakLoadBalancingAlgorithm: String? = null, val peakStartTime: TimeResponse? = null, val rampDownCapacityThresholdPct: Int? = null, val rampDownForceLogoffUsers: Boolean? = null, val rampDownLoadBalancingAlgorithm: String? = null, val rampDownMinimumHostsPct: Int? = null, val rampDownNotificationMessage: String? = null, val rampDownStartTime: TimeResponse? = null, val rampDownStopHostsWhen: String? = null, val rampDownWaitTimeMinutes: Int? = null, val rampUpCapacityThresholdPct: Int? = null, val rampUpLoadBalancingAlgorithm: String? = null, val rampUpMinimumHostsPct: Int? = null, val rampUpStartTime: TimeResponse? = null, val systemData: SystemDataResponse, val type: String)

Represents a ScalingPlanPooledSchedule definition.

Link copied to clipboard
data class GetScalingPlanResult(val description: String? = null, val etag: String, val exclusionTag: String? = null, val friendlyName: String? = null, val hostPoolReferences: List<ScalingHostPoolReferenceResponse>? = null, val hostPoolType: String? = null, val id: String, val identity: ResourceModelWithAllowedPropertySetResponseIdentity? = null, val kind: String? = null, val location: String? = null, val managedBy: String? = null, val name: String, val objectId: String, val plan: ResourceModelWithAllowedPropertySetResponsePlan? = null, val ring: Int? = null, val schedules: List<ScalingScheduleResponse>? = null, val sku: ResourceModelWithAllowedPropertySetResponseSku? = null, val tags: Map<String, String>? = null, val timeZone: String? = null, val type: String)

Represents a scaling plan definition.

Link copied to clipboard
data class GetWorkspaceResult(val applicationGroupReferences: List<String>? = null, val cloudPcResource: Boolean, val description: String? = null, val etag: String, val friendlyName: String? = null, val id: String, val identity: ResourceModelWithAllowedPropertySetResponseIdentity? = null, val kind: String? = null, val location: String? = null, val managedBy: String? = null, val name: String, val objectId: String, val plan: ResourceModelWithAllowedPropertySetResponsePlan? = null, val sku: ResourceModelWithAllowedPropertySetResponseSku? = null, val tags: Map<String, String>? = null, val type: String)

Represents a Workspace definition.

Link copied to clipboard
data class MigrationRequestPropertiesResponse(val migrationPath: String? = null, val operation: String? = null)

Properties for arm migration.

Link copied to clipboard
data class MsixPackageApplicationsResponse(val appId: String? = null, val appUserModelID: String? = null, val description: String? = null, val friendlyName: String? = null, val iconImageName: String? = null, val rawIcon: String? = null, val rawPng: String? = null)

Schema for MSIX Package Application properties.

Link copied to clipboard
data class MsixPackageDependenciesResponse(val dependencyName: String? = null, val minVersion: String? = null, val publisher: String? = null)

Schema for MSIX Package Dependencies properties.

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

The Private Endpoint resource.

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

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class RegistrationInfoResponse(val expirationTime: String? = null, val registrationTokenOperation: String? = null, val token: String? = null)

Represents a RegistrationInfo definition.

data class ResourceModelWithAllowedPropertySetResponseIdentity(val principalId: String, val tenantId: String, val type: String? = null)
data class ResourceModelWithAllowedPropertySetResponsePlan(val name: String, val product: String, val promotionCode: String? = null, val publisher: String, val version: String? = null)
data class ResourceModelWithAllowedPropertySetResponseSku(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)
Link copied to clipboard
data class ScalingHostPoolReferenceResponse(val hostPoolArmPath: String? = null, val scalingPlanEnabled: Boolean? = null)

Scaling plan reference to hostpool.

Link copied to clipboard
data class ScalingScheduleResponse(val daysOfWeek: List<String>? = null, val name: String? = null, val offPeakLoadBalancingAlgorithm: String? = null, val offPeakStartTime: String? = null, val peakLoadBalancingAlgorithm: String? = null, val peakStartTime: String? = null, val rampDownCapacityThresholdPct: Int? = null, val rampDownForceLogoffUsers: Boolean? = null, val rampDownLoadBalancingAlgorithm: String? = null, val rampDownMinimumHostsPct: Int? = null, val rampDownNotificationMessage: String? = null, val rampDownStartTime: String? = null, val rampDownStopHostsWhen: String? = null, val rampDownWaitTimeMinutes: Int? = null, val rampUpCapacityThresholdPct: Int? = null, val rampUpLoadBalancingAlgorithm: String? = null, val rampUpMinimumHostsPct: Int? = null, val rampUpStartTime: String? = null)

Scaling plan schedule.

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 TimeResponse(val hour: Int, val minute: Int)

The time for a scaling action to occur.