Package-level declarations

Types

Link copied to clipboard
data class CapabilityResponse(val name: String, val value: String)

A name/value pair to describe a capability.

Link copied to clipboard
data class CatalogConflictErrorResponse(val name: String, val path: String)

An individual conflict error.

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

Catalog error details

Link copied to clipboard
data class CatalogSyncErrorResponse(val errorDetails: List<CatalogErrorDetailsResponse>, val path: String)

An individual synchronization error.

Link copied to clipboard
data class CustomerManagedKeyEncryptionResponse(val keyEncryptionKeyIdentity: CustomerManagedKeyEncryptionResponseKeyEncryptionKeyIdentity? = null, val keyEncryptionKeyUrl: String? = null)

All Customer-managed key encryption properties for the resource.

data class CustomerManagedKeyEncryptionResponseKeyEncryptionKeyIdentity(val delegatedIdentityClientId: String? = null, val identityType: String? = null, val userAssignedIdentityResourceId: String? = null)

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Link copied to clipboard
data class DevCenterProjectCatalogSettingsResponse(val catalogItemSyncEnableStatus: String? = null)

Project catalog settings for project catalogs under a project associated to this dev center.

Link copied to clipboard
data class DevCenterSkuResponse(val capabilities: List<CapabilityResponse>, val capacity: Int? = null, val family: String? = null, val locations: List<String>, val name: String, val resourceType: String, val size: String? = null, val tier: String? = null)

The resource model definition representing SKU for DevCenter resources

Link copied to clipboard
data class EncryptionResponse(val customerManagedKeyEncryption: CustomerManagedKeyEncryptionResponse? = null)
Link copied to clipboard
data class EnvironmentRoleResponse(val description: String, val roleName: String)

A role that can be assigned to a user.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class GetAttachedNetworkByDevCenterResult(val azureApiVersion: String, val domainJoinType: String, val healthCheckStatus: String, val id: String, val name: String, val networkConnectionId: String, val networkConnectionLocation: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Represents an attached NetworkConnection.

List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.

Link copied to clipboard
data class GetCatalogResult(val adoGit: GitCatalogResponse? = null, val azureApiVersion: String, val connectionState: String, val gitHub: GitCatalogResponse? = null, val id: String, val lastConnectionTime: String, val lastSyncStats: SyncStatsResponse, val lastSyncTime: String, val name: String, val provisioningState: String, val syncState: String, val syncType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a catalog.

Link copied to clipboard

Synchronization error details.

Link copied to clipboard
data class GetCurationProfileResult(val azureApiVersion: String, val id: String, val name: String, val provisioningState: String, val resourcePolicies: List<ResourcePolicyResponse>? = null, val scopes: List<String>? = null, val systemData: SystemDataResponse, val type: String)

Represents an curation profile resource.

Link copied to clipboard

List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.

Link copied to clipboard
data class GetDevBoxDefinitionResult(val activeImageReference: ImageReferenceResponse, val azureApiVersion: String, val hibernateSupport: String? = null, val id: String, val imageReference: ImageReferenceResponse, val imageValidationErrorDetails: ImageValidationErrorDetailsResponse, val imageValidationStatus: String, val location: String, val name: String, val osStorageType: String? = null, val provisioningState: String, val sku: SkuResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val validationStatus: String)

Represents a definition for a Developer Machine.

data class GetDevCenterCatalogImageDefinitionBuildDetailsResult(val endTime: String, val errorDetails: ImageCreationErrorDetailsResponse, val id: String, val imageReference: ImageReferenceResponse, val name: String, val startTime: String, val status: String, val systemData: SystemDataResponse, val taskGroups: List<ImageDefinitionBuildTaskGroupResponse>, val type: String)

Represents a specific build of an Image Definition.

List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.

Link copied to clipboard
data class GetDevCenterResult(val azureApiVersion: String, val devCenterUri: String, val displayName: String? = null, val encryption: EncryptionResponse? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val projectCatalogSettings: DevCenterProjectCatalogSettingsResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a devcenter resource.

Link copied to clipboard
data class GetEncryptionSetResult(val azureApiVersion: String, val devboxDisksEncryptionEnableStatus: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val keyEncryptionKeyUrl: String? = null, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a devcenter encryption set resource.

List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.

Link copied to clipboard
data class GetEnvironmentTypeResult(val azureApiVersion: String, val displayName: String? = null, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents an environment type.

Link copied to clipboard
data class GetGalleryResult(val azureApiVersion: String, val galleryResourceId: String, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Represents a gallery.

Link copied to clipboard
data class GetNetworkConnectionResult(val azureApiVersion: String, val domainJoinType: String, val domainName: String? = null, val domainPassword: String? = null, val domainUsername: String? = null, val healthCheckStatus: String, val id: String, val location: String, val name: String, val networkingResourceGroupName: String? = null, val organizationUnit: String? = null, val provisioningState: String, val subnetId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Network related settings

Link copied to clipboard
data class GetPlanMemberResult(val azureApiVersion: String, val id: String, val memberId: String? = null, val memberType: String? = null, val name: String, val provisioningState: String, val syncStatus: PlanMemberSyncStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tier: String? = null, val type: String)

Represents a devcenter plan member resource.

Link copied to clipboard
data class GetPlanResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val provisioningState: String, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a devcenter plan resource.

Link copied to clipboard
data class GetPoolResult(val azureApiVersion: String, val devBoxCount: Int, val devBoxDefinitionName: String, val displayName: String? = null, val healthStatus: String, val healthStatusDetails: List<HealthStatusDetailResponse>, val id: String, val licenseType: String, val localAdministrator: String, val location: String, val managedVirtualNetworkRegions: List<String>? = null, val name: String, val networkConnectionName: String, val provisioningState: String, val singleSignOnStatus: String? = null, val stopOnDisconnect: StopOnDisconnectConfigurationResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualNetworkType: String? = null)

A pool of Virtual Machines.

List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.

data class GetProjectCatalogImageDefinitionBuildDetailsResult(val endTime: String, val errorDetails: ImageCreationErrorDetailsResponse, val id: String, val imageReference: ImageReferenceResponse, val name: String, val startTime: String, val status: String, val systemData: SystemDataResponse, val taskGroups: List<ImageDefinitionBuildTaskGroupResponse>, val type: String)

Represents a specific build of an Image Definition.

List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.

Link copied to clipboard
data class GetProjectCatalogResult(val adoGit: GitCatalogResponse? = null, val azureApiVersion: String, val connectionState: String, val gitHub: GitCatalogResponse? = null, val id: String, val lastConnectionTime: String, val lastSyncStats: SyncStatsResponse, val lastSyncTime: String, val name: String, val provisioningState: String, val syncState: String, val syncType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a catalog.

Link copied to clipboard

Synchronization error details.

Link copied to clipboard
data class GetProjectEnvironmentTypeResult(val azureApiVersion: String, val creatorRoleAssignment: ProjectEnvironmentTypeUpdatePropertiesResponseCreatorRoleAssignment? = null, val deploymentTargetId: String? = null, val displayName: String? = null, val environmentCount: Int, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String? = null, val name: String, val provisioningState: String, val status: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userRoleAssignments: Map<String, UserRoleAssignmentResponse>? = null)

Represents an environment type.

Link copied to clipboard

Applicable inherited settings for a project.

Link copied to clipboard
data class GetProjectPolicyResult(val azureApiVersion: String, val id: String, val name: String, val provisioningState: String, val resourcePolicies: List<ResourcePolicyResponse>? = null, val scopes: List<String>? = null, val systemData: SystemDataResponse, val type: String)

Represents an project policy resource.

Link copied to clipboard
data class GetProjectResult(val azureApiVersion: String, val catalogSettings: ProjectCatalogSettingsResponse? = null, val description: String? = null, val devCenterId: String? = null, val devCenterUri: String, val displayName: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val maxDevBoxesPerUser: Int? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a project resource.

Link copied to clipboard
data class GetScheduleResult(val azureApiVersion: String, val frequency: String, val id: String, val location: String? = null, val name: String, val provisioningState: String, val state: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val time: String, val timeZone: String, val type: String)

Represents a Schedule to execute a task.

Link copied to clipboard
data class GitCatalogResponse(val branch: String? = null, val path: String? = null, val secretIdentifier: String? = null, val uri: String? = null)

Properties for a Git repository catalog.

Link copied to clipboard
data class HealthStatusDetailResponse(val code: String, val message: String)

Pool health status detail.

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

Image creation error details

Link copied to clipboard
data class ImageDefinitionBuildTaskGroupResponse(val endTime: String, val name: String, val startTime: String, val status: String, val tasks: List<ImageDefinitionBuildTaskResponse>)

A task group executed during the image definition build.

Link copied to clipboard
data class ImageDefinitionBuildTaskResponse(val displayName: String? = null, val endTime: String, val id: String, val logUri: String, val name: String? = null, val parameters: List<ImageDefinitionBuildTaskResponseParameters>? = null, val startTime: String, val status: String)

A task executed during the image definition build.

Link copied to clipboard
data class ImageReferenceResponse(val exactVersion: String, val id: String? = null)

Image reference information

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

Image validation error details

Link copied to clipboard
data class ListSkusByProjectResult(val nextLink: String, val value: List<DevCenterSkuResponse>)

Results of the Microsoft.DevCenter SKU list operation.

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

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class PlanMemberSyncStatusResponse(val lastSyncError: ErrorDetailResponse? = null, val lastSyncTime: String, val syncState: String)

The sync status of the plan member.

Link copied to clipboard
data class ProjectCatalogSettingsResponse(val catalogItemSyncTypes: List<String>? = null)

Settings to be used when associating a project with a catalog.

The role definition assigned to the environment creator on backing resources.

Link copied to clipboard
data class ProjectNetworkSettingsResponse(val microsoftHostedNetworkEnableStatus: String)

Network settings for the project.

Link copied to clipboard
data class ResourcePolicyResponse(val filter: String? = null, val resources: String? = null)

A resource policy.

Link copied to clipboard
data class SkuResponse(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)

The resource model definition representing SKU

Link copied to clipboard
data class StopOnDisconnectConfigurationResponse(val gracePeriodMinutes: Int? = null, val status: String? = null)

Stop on disconnect configuration settings for Dev Boxes created in this pool.

Link copied to clipboard
data class SyncStatsResponse(val added: Int, val removed: Int, val syncedCatalogItemTypes: List<String>? = null, val synchronizationErrors: Int, val unchanged: Int, val updated: Int, val validationErrors: Int)

Stats of the synchronization.

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 UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard

Mapping of user object ID to role assignments.