@azure/arm-devcenter package

Classes

DevCenterClient

Interfaces

ActiveHoursConfiguration

Active hours configuration.

AllowedEnvironmentType

Represents an allowed environment type.

AllowedEnvironmentTypeProperties

Properties of an allowed environment type.

AssignedGroup

Represents an Entra group assigned to this Project, entitling all members to resources for the given scope.

AttachedNetworkConnection

Represents an attached NetworkConnection.

AttachedNetworkConnectionProperties

Properties of an attached NetworkConnection.

AttachedNetworksCreateOrUpdateOptionalParams

Optional parameters.

AttachedNetworksDeleteOptionalParams

Optional parameters.

AttachedNetworksGetByDevCenterOptionalParams

Optional parameters.

AttachedNetworksGetByProjectOptionalParams

Optional parameters.

AttachedNetworksListByDevCenterOptionalParams

Optional parameters.

AttachedNetworksListByProjectOptionalParams

Optional parameters.

AttachedNetworksOperations

Interface representing a AttachedNetworks operations.

AzureAiServicesSettings

Configures Azure AI related services for the project.

Capability

A name/value pair to describe a capability.

Catalog

Represents a catalog.

CatalogConflictError

An individual conflict error.

CatalogErrorDetails

Catalog error details

CatalogProperties

Properties of a catalog.

CatalogResourceValidationErrorDetails

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.

CatalogSyncError

An individual synchronization error.

CatalogUpdate

The catalog's properties for partial update. Properties not provided in the update request will not be changed.

CatalogUpdateProperties

Properties of a catalog. These properties can be updated after the resource has been created.

CatalogsConnectOptionalParams

Optional parameters.

CatalogsCreateOrUpdateOptionalParams

Optional parameters.

CatalogsDeleteOptionalParams

Optional parameters.

CatalogsGetOptionalParams

Optional parameters.

CatalogsGetSyncErrorDetailsOptionalParams

Optional parameters.

CatalogsListByDevCenterOptionalParams

Optional parameters.

CatalogsOperations

Interface representing a Catalogs operations.

CatalogsSyncOptionalParams

Optional parameters.

CatalogsUpdateOptionalParams

Optional parameters.

CheckNameAvailabilityExecuteOptionalParams

Optional parameters.

CheckNameAvailabilityOperations

Interface representing a CheckNameAvailability operations.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

CheckScopedNameAvailabilityExecuteOptionalParams

Optional parameters.

CheckScopedNameAvailabilityOperations

Interface representing a CheckScopedNameAvailability operations.

CheckScopedNameAvailabilityRequest

The scoped name check availability request body.

ConfigurationPolicies

Represents policies to enforce configuration settings on a project.

CustomerManagedKeyEncryption

Customer-managed key encryption properties for the resource.

CustomerManagedKeyEncryptionKeyIdentity

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

CustomizationTask

Represents a Task to be used in customizing a Dev Box.

CustomizationTaskInput

Input for a Task.

CustomizationTaskInstance

A customization task to run.

CustomizationTaskProperties

Properties of a Task.

CustomizationTasksGetErrorDetailsOptionalParams

Optional parameters.

CustomizationTasksGetOptionalParams

Optional parameters.

CustomizationTasksListByCatalogOptionalParams

Optional parameters.

CustomizationTasksOperations

Interface representing a CustomizationTasks operations.

DefaultValue

A default value that can be provided for a feature property.

DefinitionParametersItem

Parameters for the task.

DevBoxDefinition

Represents a definition for a Developer Machine.

DevBoxDefinitionProperties

Properties of a Dev Box definition.

DevBoxDefinitionUpdate

Partial update of a Dev Box definition resource.

DevBoxDefinitionUpdateProperties

Properties of a Dev Box definition. These properties can be updated after the resource has been created.

DevBoxDefinitionsCreateOrUpdateOptionalParams

Optional parameters.

DevBoxDefinitionsDeleteOptionalParams

Optional parameters.

DevBoxDefinitionsGetByProjectOptionalParams

Optional parameters.

DevBoxDefinitionsGetOptionalParams

Optional parameters.

DevBoxDefinitionsListByDevCenterOptionalParams

Optional parameters.

DevBoxDefinitionsListByProjectOptionalParams

Optional parameters.

DevBoxDefinitionsOperations

Interface representing a DevBoxDefinitions operations.

DevBoxDefinitionsUpdateOptionalParams

Optional parameters.

DevBoxProvisioningSettings

Provisioning settings that apply to all Dev Boxes created in this dev center.

DevBoxScheduleDeleteSettings

Settings controlling the auto deletion of inactive dev boxes.

DevCenter

Represents a devcenter resource.

DevCenterCatalogImageDefinitionBuildCancelOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionBuildGetBuildDetailsOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionBuildGetOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionBuildOperations

Interface representing a DevCenterCatalogImageDefinitionBuild operations.

DevCenterCatalogImageDefinitionBuildsListByImageDefinitionOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionBuildsOperations

Interface representing a DevCenterCatalogImageDefinitionBuilds operations.

DevCenterCatalogImageDefinitionsBuildImageOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionsGetByDevCenterCatalogOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionsGetErrorDetailsOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionsListByDevCenterCatalogOptionalParams

Optional parameters.

DevCenterCatalogImageDefinitionsOperations

Interface representing a DevCenterCatalogImageDefinitions operations.

DevCenterClientOptionalParams

Optional parameters for the client.

DevCenterEncryptionSet

Represents a devcenter encryption set resource.

DevCenterEncryptionSetProperties

Properties of the devcenter encryption set.

DevCenterEncryptionSetUpdateProperties

Properties of the devcenter encryption set. These properties can be updated after the resource has been created.

DevCenterNetworkSettings

Network settings for the Dev Center.

DevCenterProjectCatalogSettings

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

DevCenterProperties

Properties of the devcenter.

DevCenterSku

The resource model definition representing SKU for DevCenter resources.

DevCenterUpdate

The devcenter resource for partial updates. Properties not provided in the update request will not be changed.

DevCenterUpdateProperties

Properties of the devcenter. These properties can be updated after the resource has been created.

DevCentersCreateOrUpdateOptionalParams

Optional parameters.

DevCentersDeleteOptionalParams

Optional parameters.

DevCentersGetOptionalParams

Optional parameters.

DevCentersListByResourceGroupOptionalParams

Optional parameters.

DevCentersListBySubscriptionOptionalParams

Optional parameters.

DevCentersOperations

Interface representing a DevCenters operations.

DevCentersUpdateOptionalParams

Optional parameters.

Encryption

Encryption properties.

EncryptionSetUpdate

The devcenter encryption set resource for partial updates. Properties not provided in the update request will not be changed.

EncryptionSetsCreateOrUpdateOptionalParams

Optional parameters.

EncryptionSetsDeleteOptionalParams

Optional parameters.

EncryptionSetsGetOptionalParams

Optional parameters.

EncryptionSetsListOptionalParams

Optional parameters.

EncryptionSetsOperations

Interface representing a EncryptionSets operations.

EncryptionSetsUpdateOptionalParams

Optional parameters.

EndpointDependency

A domain name and connection details used to access a dependency.

EndpointDetail

Details about the connection between the Batch service and the endpoint.

EnvironmentDefinition

Represents an environment definition catalog item.

EnvironmentDefinitionParameter

Properties of an Environment Definition parameter.

EnvironmentDefinitionProperties

Properties of an environment definition.

EnvironmentDefinitionsGetByProjectCatalogOptionalParams

Optional parameters.

EnvironmentDefinitionsGetErrorDetailsOptionalParams

Optional parameters.

EnvironmentDefinitionsGetOptionalParams

Optional parameters.

EnvironmentDefinitionsListByCatalogOptionalParams

Optional parameters.

EnvironmentDefinitionsListByProjectCatalogOptionalParams

Optional parameters.

EnvironmentDefinitionsOperations

Interface representing a EnvironmentDefinitions operations.

EnvironmentRole

A role that can be assigned to a user.

EnvironmentType

Represents an environment type.

EnvironmentTypeProperties

Properties of an environment type.

EnvironmentTypeUpdate

The environment type for partial update. Properties not provided in the update request will not be changed.

EnvironmentTypeUpdateProperties

Properties of an environment type. These properties can be updated after the resource has been created.

EnvironmentTypesCreateOrUpdateOptionalParams

Optional parameters.

EnvironmentTypesDeleteOptionalParams

Optional parameters.

EnvironmentTypesGetOptionalParams

Optional parameters.

EnvironmentTypesListByDevCenterOptionalParams

Optional parameters.

EnvironmentTypesOperations

Interface representing a EnvironmentTypes operations.

EnvironmentTypesUpdateOptionalParams

Optional parameters.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

FeatureState

Feature state.

GalleriesCreateOrUpdateOptionalParams

Optional parameters.

GalleriesDeleteOptionalParams

Optional parameters.

GalleriesGetOptionalParams

Optional parameters.

GalleriesListByDevCenterOptionalParams

Optional parameters.

GalleriesOperations

Interface representing a Galleries operations.

Gallery

Represents a gallery.

GalleryProperties

Properties of a gallery.

GitCatalog

Properties for a Git repository catalog.

HealthCheck

An individual health check item.

HealthCheckStatusDetails

Health Check details.

HealthCheckStatusDetailsProperties

Health Check properties.

HealthStatusDetail

Pool health status detail.

Image

Represents an image.

ImageCreationErrorDetails

Image creation error details.

ImageDefinition

Represents a definition for an Image.

ImageDefinitionBuild

Represents a specific build of an Image Definition.

ImageDefinitionBuildDetails

Represents a specific build of an Image Definition.

ImageDefinitionBuildProperties

Properties of an Image Definition Build.

ImageDefinitionBuildTask

A task executed during the image definition build.

ImageDefinitionBuildTaskGroup

A task group executed during the image definition build.

ImageDefinitionBuildTaskParametersItem

Parameters for an image definition build task.

ImageDefinitionProperties

Properties of an Image Definition.

ImageDefinitionReference

A reference to an Image Definition.

ImageProperties

Properties of an image.

ImageReference

Image reference information.

ImageValidationErrorDetails

Image validation error details.

ImageVersion

Represents an image version.

ImageVersionProperties

Properties of an image version.

ImageVersionsGetByProjectOptionalParams

Optional parameters.

ImageVersionsGetOptionalParams

Optional parameters.

ImageVersionsListByImageOptionalParams

Optional parameters.

ImageVersionsListByProjectOptionalParams

Optional parameters.

ImageVersionsOperations

Interface representing a ImageVersions operations.

ImagesGetByProjectOptionalParams

Optional parameters.

ImagesGetOptionalParams

Optional parameters.

ImagesListByDevCenterOptionalParams

Optional parameters.

ImagesListByGalleryOptionalParams

Optional parameters.

ImagesListByProjectOptionalParams

Optional parameters.

ImagesOperations

Interface representing a Images operations.

InheritedProjectCatalogSettings

Inherited project catalog settings that combine project policy settings with dev center catalog settings.

InheritedSettingsForProject

Applicable inherited settings for a project.

KeyEncryptionKeyIdentityUpdate

The managed identity configuration used for key vault access.

LatestImageBuild

Details about the latest build.

ManagedServiceIdentity

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

NetworkConnection

Network related settings.

NetworkConnectionUpdate

The network connection properties for partial update. Properties not provided in the update request will not be changed.

NetworkConnectionUpdateProperties

Properties of network connection. These properties can be updated after the resource has been created.

NetworkConnectionsCreateOrUpdateOptionalParams

Optional parameters.

NetworkConnectionsDeleteOptionalParams

Optional parameters.

NetworkConnectionsGetHealthDetailsOptionalParams

Optional parameters.

NetworkConnectionsGetOptionalParams

Optional parameters.

NetworkConnectionsListByResourceGroupOptionalParams

Optional parameters.

NetworkConnectionsListBySubscriptionOptionalParams

Optional parameters.

NetworkConnectionsListHealthDetailsOptionalParams

Optional parameters.

NetworkConnectionsListOutboundNetworkDependenciesEndpointsOptionalParams

Optional parameters.

NetworkConnectionsOperations

Interface representing a NetworkConnections operations.

NetworkConnectionsRunHealthChecksOptionalParams

Optional parameters.

NetworkConnectionsUpdateOptionalParams

Optional parameters.

NetworkProperties

Network properties

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for an operation.

OperationStatus

The current status of an async operation

OperationStatusResult

The current status of an async operation.

OperationStatusesGetOptionalParams

Optional parameters.

OperationStatusesOperations

Interface representing a OperationStatuses operations.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

OutboundEnvironmentEndpoint

A collection of related endpoints from the same service for which the agent requires outbound access.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

Pool

A pool of Virtual Machines.

PoolDevBoxDefinition

Represents a definition for a Developer Machine.

PoolProperties

Properties of a Pool.

PoolUpdate

The pool properties for partial update. Properties not provided in the update request will not be changed.

PoolUpdateProperties

Properties of a Pool. These properties can be updated after the resource has been created.

PoolsCreateOrUpdateOptionalParams

Optional parameters.

PoolsDeleteOptionalParams

Optional parameters.

PoolsGetOptionalParams

Optional parameters.

PoolsListByProjectOptionalParams

Optional parameters.

PoolsOperations

Interface representing a Pools operations.

PoolsRunHealthChecksOptionalParams

Optional parameters.

PoolsUpdateOptionalParams

Optional parameters.

Project

Represents a project resource.

ProjectAllowedEnvironmentTypesGetOptionalParams

Optional parameters.

ProjectAllowedEnvironmentTypesListOptionalParams

Optional parameters.

ProjectAllowedEnvironmentTypesOperations

Interface representing a ProjectAllowedEnvironmentTypes operations.

ProjectCatalogEnvironmentDefinitionsGetErrorDetailsOptionalParams

Optional parameters.

ProjectCatalogEnvironmentDefinitionsOperations

Interface representing a ProjectCatalogEnvironmentDefinitions operations.

ProjectCatalogImageDefinitionBuildCancelOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionBuildGetBuildDetailsOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionBuildGetOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionBuildOperations

Interface representing a ProjectCatalogImageDefinitionBuild operations.

ProjectCatalogImageDefinitionBuildsListByImageDefinitionOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionBuildsOperations

Interface representing a ProjectCatalogImageDefinitionBuilds operations.

ProjectCatalogImageDefinitionsBuildImageOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionsGetByProjectCatalogOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionsGetErrorDetailsOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionsListByProjectCatalogOptionalParams

Optional parameters.

ProjectCatalogImageDefinitionsOperations

Interface representing a ProjectCatalogImageDefinitions operations.

ProjectCatalogSettings

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

ProjectCatalogsConnectOptionalParams

Optional parameters.

ProjectCatalogsCreateOrUpdateOptionalParams

Optional parameters.

ProjectCatalogsDeleteOptionalParams

Optional parameters.

ProjectCatalogsGetOptionalParams

Optional parameters.

ProjectCatalogsGetSyncErrorDetailsOptionalParams

Optional parameters.

ProjectCatalogsListOptionalParams

Optional parameters.

ProjectCatalogsOperations

Interface representing a ProjectCatalogs operations.

ProjectCatalogsPatchOptionalParams

Optional parameters.

ProjectCatalogsSyncOptionalParams

Optional parameters.

ProjectCustomizationManagedIdentity

A reference to a Managed Identity that is attached to the Project.

ProjectCustomizationSettings

Settings to be used for customizations.

ProjectEnvironmentType

Represents an environment type.

ProjectEnvironmentTypeProperties

Properties of a project environment type.

ProjectEnvironmentTypeUpdate

The project environment type for partial update. Properties not provided in the update request will not be changed.

ProjectEnvironmentTypeUpdateProperties

Properties of a project environment type. These properties can be updated after the resource has been created.

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment

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

ProjectEnvironmentTypesCreateOrUpdateOptionalParams

Optional parameters.

ProjectEnvironmentTypesDeleteOptionalParams

Optional parameters.

ProjectEnvironmentTypesGetOptionalParams

Optional parameters.

ProjectEnvironmentTypesListOptionalParams

Optional parameters.

ProjectEnvironmentTypesOperations

Interface representing a ProjectEnvironmentTypes operations.

ProjectEnvironmentTypesUpdateOptionalParams

Optional parameters.

ProjectNetworkSettings

Network settings for the project.

ProjectPoliciesCreateOrUpdateOptionalParams

Optional parameters.

ProjectPoliciesDeleteOptionalParams

Optional parameters.

ProjectPoliciesGetOptionalParams

Optional parameters.

ProjectPoliciesListByDevCenterOptionalParams

Optional parameters.

ProjectPoliciesOperations

Interface representing a ProjectPolicies operations.

ProjectPoliciesUpdateOptionalParams

Optional parameters.

ProjectPolicy

Represents an project policy resource.

ProjectPolicyProperties

Properties of an project policy.

ProjectPolicyUpdate

The project policy properties for partial update. Properties not provided in the update request will not be changed.

ProjectPolicyUpdateProperties

Properties of an project policy. These properties can be updated after the resource has been created.

ProjectProperties

Properties of a project.

ProjectUpdate

The project properties for partial update. Properties not provided in the update request will not be changed.

ProjectUpdateProperties

Properties of a project. These properties can be updated after the resource has been created.

ProjectsCreateOrUpdateOptionalParams

Optional parameters.

ProjectsDeleteOptionalParams

Optional parameters.

ProjectsGetInheritedSettingsOptionalParams

Optional parameters.

ProjectsGetOptionalParams

Optional parameters.

ProjectsListByResourceGroupOptionalParams

Optional parameters.

ProjectsListBySubscriptionOptionalParams

Optional parameters.

ProjectsOperations

Interface representing a Projects operations.

ProjectsUpdateOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

RecommendedMachineConfiguration

Properties for a recommended machine configuration.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourcePolicy

A resource policy.

ResourceRange

Properties for a range of values.

RestorePollerOptions
Schedule

Represents a Schedule to execute a task.

ScheduleProperties

The Schedule properties defining when and what to execute.

ScheduleUpdate

The schedule properties for partial update. Properties not provided in the update request will not be changed.

ScheduleUpdateProperties

Updatable properties of a Schedule.

SchedulesCreateOrUpdateOptionalParams

Optional parameters.

SchedulesDeleteOptionalParams

Optional parameters.

SchedulesGetOptionalParams

Optional parameters.

SchedulesListByPoolOptionalParams

Optional parameters.

SchedulesOperations

Interface representing a Schedules operations.

SchedulesUpdateOptionalParams

Optional parameters.

ServerlessGpuSessionsSettings

Represents settings for serverless GPU access.

SimplePollerLike

A simple poller that can be used to poll a long running operation.

Sku

The resource model definition representing SKU

SkusListByProjectOptionalParams

Optional parameters.

SkusListBySubscriptionOptionalParams

Optional parameters.

SkusOperations

Interface representing a Skus operations.

StopOnDisconnectConfiguration

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

StopOnNoConnectConfiguration

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

SyncErrorDetails

Synchronization error details.

SyncStats

Stats of the synchronization.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Usage

The core usage details.

UsageName

The Usage Names.

UsagesListByLocationOptionalParams

Optional parameters.

UsagesOperations

Interface representing a Usages operations.

UserAssignedIdentity

User assigned identity properties

UserRoleAssignmentValue

Mapping of user object ID to role assignments.

WorkspaceStorageSettings

Settings to be used for workspace storage.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

ArchitectureType

Architecture Types.
KnownArchitectureType can be used interchangeably with ArchitectureType, this enum contains the known values that the service supports.

Known values supported by the service

x64: x64 architecture
Arm64: ARM64 architecture

AssignedGroupScope

The scope of an assignment.
KnownAssignedGroupScope can be used interchangeably with AssignedGroupScope, this enum contains the known values that the service supports.

Known values supported by the service

DevBox: Assignment entitles group members to Dev Boxes in the Project.

AutoImageBuildStatus

Indicates whether auto image build is enabled/disabled.
KnownAutoImageBuildStatus can be used interchangeably with AutoImageBuildStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Auto image build is disabled.
Enabled: Auto image build is enabled.

AutoStartEnableStatus

Enables or disables whether Dev Boxes should be automatically started at commencement of active hours.
KnownAutoStartEnableStatus can be used interchangeably with AutoStartEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Auto start is enabled.
Disabled: Auto start is disabled.

AzureAiServicesMode

Indicates whether Azure AI services are enabled for a project.
KnownAzureAiServicesMode can be used interchangeably with AzureAiServicesMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Azure AI services are disabled for this project.
AutoDeploy: Azure AI services are enabled for this project and necessary resources will be automatically setup.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

CancelOnConnectEnableStatus

Indicates whether cancel on connect is enabled.
KnownCancelOnConnectEnableStatus can be used interchangeably with CancelOnConnectEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Cancel on connect is enabled.
Disabled: Cancel on connect is disabled.

CatalogAutoImageBuildEnableStatus

Indicates whether auto image build is enabled/disabled for image definitions in the catalog.
KnownCatalogAutoImageBuildEnableStatus can be used interchangeably with CatalogAutoImageBuildEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Auto image build is disabled.
Enabled: Auto image build is enabled.

CatalogConnectionState

The connection state of the catalog.
KnownCatalogConnectionState can be used interchangeably with CatalogConnectionState, this enum contains the known values that the service supports.

Known values supported by the service

Connected: Connected state.
Disconnected: Disconnected state.

CatalogItemSyncEnableStatus

Catalog item sync types enable or disable status. Indicates whether project catalogs are allowed to sync catalog items under projects associated to this dev center.
KnownCatalogItemSyncEnableStatus can be used interchangeably with CatalogItemSyncEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Catalog item sync is enabled.
Disabled: Catalog item sync is disabled.

CatalogItemType

Indicates catalog item types.
KnownCatalogItemType can be used interchangeably with CatalogItemType, this enum contains the known values that the service supports.

Known values supported by the service

EnvironmentDefinition: Environment definition catalog item type.
ImageDefinition: Image definition catalog item type.

CatalogResourceValidationStatus

Catalog resource validation status.
KnownCatalogResourceValidationStatus can be used interchangeably with CatalogResourceValidationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown validation status.
Pending: Pending validation status.
Succeeded: Succeeded validation status.
Failed: Failed validation status.

CatalogSyncState

The synchronization state of the catalog.
KnownCatalogSyncState can be used interchangeably with CatalogSyncState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded synchronization state.
InProgress: In progress synchronization state.
Failed: Failed synchronization state.
Canceled: Canceled synchronization state.

CatalogSyncType

Indicates the type of sync that is configured for the catalog.
KnownCatalogSyncType can be used interchangeably with CatalogSyncType, this enum contains the known values that the service supports.

Known values supported by the service

Manual: Manual sync type.
Scheduled: Scheduled sync type.

CheckNameAvailabilityReason

Possible reasons for a name not being available.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Name is invalid.
AlreadyExists: Name already exists.

CmkIdentityType

The type of identity used to access the key vault key.
KnownCmkIdentityType can be used interchangeably with CmkIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: System assigned identity type.
UserAssigned: User assigned identity type.

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

CustomizationTaskInputType

Type of the input.
KnownCustomizationTaskInputType can be used interchangeably with CustomizationTaskInputType, this enum contains the known values that the service supports.

Known values supported by the service

string: The parameter accepts a string value.
number: The parameter accepts a number value.
boolean: The parameter accepts a boolean value.

DayOfWeek

The days of the week.

DevBoxDeleteMode

Indicates possible values for Dev Box delete mode.
KnownDevBoxDeleteMode can be used interchangeably with DevBoxDeleteMode, this enum contains the known values that the service supports.

Known values supported by the service

Manual: Dev Boxes will not be deleted automatically, and user must manually delete. This is the default.
Auto: Dev Boxes will be deleted automatically according to configured settings.

DevBoxTunnelEnableStatus

Indicates whether Dev Box Tunnel is enabled.
KnownDevBoxTunnelEnableStatus can be used interchangeably with DevBoxTunnelEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Dev Box Tunnel is enabled.
Enabled: Dev Box Tunnel is disabled.

DevCenterResourceType

Indicates dev center resource types.
KnownDevCenterResourceType can be used interchangeably with DevCenterResourceType, this enum contains the known values that the service supports.

Known values supported by the service

Images: Images resource type.
AttachedNetworks: Attached networks resource type.
Skus: Skus resource type.

DevboxDisksEncryptionEnableStatus

Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption is enabled or not.
KnownDevboxDisksEncryptionEnableStatus can be used interchangeably with DevboxDisksEncryptionEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Devbox disks encryption is enabled.
Disabled: Devbox disks encryption is disabled.

DomainJoinType

Active Directory join type.
KnownDomainJoinType can be used interchangeably with DomainJoinType, this enum contains the known values that the service supports.

Known values supported by the service

HybridAzureADJoin: Hybrid Azure AD Join type.
AzureADJoin: Azure AD Join type.
None: No Active Directory join type.

EnvironmentTypeEnableStatus

Indicates whether the environment type is either enabled or disabled.
KnownEnvironmentTypeEnableStatus can be used interchangeably with EnvironmentTypeEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Environment type is enabled.
Disabled: Environment type is disabled.

FeatureStateModifiable

Feature enablement status.
KnownFeatureStateModifiable can be used interchangeably with FeatureStateModifiable, this enum contains the known values that the service supports.

Known values supported by the service

NotModifiable: Feature is not modifiable.
Modifiable: Feature is modifiable.

FeatureStatus

Feature status.
KnownFeatureStatus can be used interchangeably with FeatureStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Feature is enabled.
Disabled: Feature is disabled.
AutoDeploy: Auto Deploy feature status.

HealthCheckStatus

Health check status values.
KnownHealthCheckStatus can be used interchangeably with HealthCheckStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown health check status.
Pending: Pending health check status.
Running: Running health check status.
Passed: Passed health check status.
Warning: Warning health check status.
Failed: Failed health check status.
Informational: Informational health check status.

HealthStatus

Health status indicating whether a pool is available to create Dev Boxes.
KnownHealthStatus can be used interchangeably with HealthStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown health status.
Pending: Pending health status.
Healthy: Healthy health status.
Warning: Warning health status.
Unhealthy: Unhealthy health status.

HibernateSupport

Indicates whether hibernate is enabled/disabled.
KnownHibernateSupport can be used interchangeably with HibernateSupport, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Hibernate is disabled.
Enabled: Hibernate is enabled.

IdentityType

The type of identity to use.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

systemAssignedIdentity: System assigned identity
userAssignedIdentity: User assigned identity
delegatedResourceIdentity: Delegated identity

ImageDefinitionBuildStatus

The state of an Image Definition Build.
KnownImageDefinitionBuildStatus can be used interchangeably with ImageDefinitionBuildStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The image build has succeeded.
Running: The image build is running.
ValidationFailed: The built image has failed validation.
Failed: The image build has failed.
Cancelled: The image build has been cancelled.
TimedOut: The image build has timed out.

ImageValidationStatus

Image validation status.
KnownImageValidationStatus can be used interchangeably with ImageValidationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown image validation status.
Pending: Pending image validation status.
Succeeded: Succeeded image validation status.
Failed: Failed image validation status.
TimedOut: Timed out image validation status.

InstallAzureMonitorAgentEnableStatus

Setting to be used when determining whether to install the Azure Monitor Agent service on Dev Boxes that belong to this dev center.
KnownInstallAzureMonitorAgentEnableStatus can be used interchangeably with InstallAzureMonitorAgentEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Azure Monitor Agent service is enabled.
Disabled: Azure Monitor Agent service is disabled.

KeepAwakeEnableStatus

Enables or disables whether Dev Boxes should be kept awake during active hours.
KnownKeepAwakeEnableStatus can be used interchangeably with KeepAwakeEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Keep awake is enabled.
Disabled: Keep awake is disabled.

LicenseType

License Types
KnownLicenseType can be used interchangeably with LicenseType, this enum contains the known values that the service supports.

Known values supported by the service

Windows_Client: Windows Client license type.

LocalAdminStatus

Local Administrator enable or disable status. Indicates whether owners of Dev Boxes are added as local administrators on the Dev Box.
KnownLocalAdminStatus can be used interchangeably with LocalAdminStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Local administrator is disabled.
Enabled: Local administrator is enabled.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

MicrosoftHostedNetworkEnableStatus

Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set.
KnownMicrosoftHostedNetworkEnableStatus can be used interchangeably with MicrosoftHostedNetworkEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Microsoft Hosted Networks are enabled for this Dev Center.
Disabled: Microsoft Hosted Networks are disabled for this Dev Center.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ParameterType

The type of data a parameter accepts.
KnownParameterType can be used interchangeably with ParameterType, this enum contains the known values that the service supports.

Known values supported by the service

array: The parameter accepts an array of values.
boolean: The parameter accepts a boolean value.
integer: The parameter accepts an integer value.
number: The parameter accepts a number value.
object: The parameter accepts an object value.
string: The parameter accepts a string value.

PolicyAction

Indicates what action to perform for the policy.
KnownPolicyAction can be used interchangeably with PolicyAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow: Allow action for the policy.
Deny: Deny action for the policy.

PoolDevBoxDefinitionType

Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.
KnownPoolDevBoxDefinitionType can be used interchangeably with PoolDevBoxDefinitionType, this enum contains the known values that the service supports.

Known values supported by the service

Reference: Indicates the pool is created from an existing Dev Box definition.
Value: Indicates the pool is created from a Dev Box definition that's created from an image reference and a SKU directly. This is used for creating an image definition pool or an image pool.

ProjectCustomizationIdentityType

Values can be systemAssignedIdentity or userAssignedIdentity
KnownProjectCustomizationIdentityType can be used interchangeably with ProjectCustomizationIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

systemAssignedIdentity: System assigned identity type.
userAssignedIdentity: User assigned identity type.

ProvisioningState

Provisioning state of the resource.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

NotSpecified: Not specified provisioning state.
Accepted: Accepted provisioning state.
Running: Running provisioning state.
Creating: Creating provisioning state.
Created: Created provisioning state.
Updating: Updating provisioning state.
Updated: Updated provisioning state.
Deleting: Deleting provisioning state.
Deleted: Deleted provisioning state.
Succeeded: Succeeded provisioning state.
Failed: Failed provisioning state.
Canceled: Canceled provisioning state.
MovingResources: Moving resources provisioning state.
TransientFailure: Transient failure provisioning state.
RolloutInProgress: Rollout in progress provisioning state.
StorageProvisioningFailed: Storage provisioning failed provisioning state.

ScheduleEnableStatus

Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled.
KnownScheduleEnableStatus can be used interchangeably with ScheduleEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Schedule is enabled.
Disabled: Schedule is disabled.

ScheduledFrequency

The frequency of task execution.
KnownScheduledFrequency can be used interchangeably with ScheduledFrequency, this enum contains the known values that the service supports.

Known values supported by the service

Daily: The scheduled task will run daily.

ScheduledType

The supported types for a scheduled task.
KnownScheduledType can be used interchangeably with ScheduledType, this enum contains the known values that the service supports.

Known values supported by the service

StopDevBox: Stop Dev Box task type.

ServerlessGpuSessionsMode

Indicates whether serverless GPU session access is enabled.
KnownServerlessGpuSessionsMode can be used interchangeably with ServerlessGpuSessionsMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Serverless GPU session access is disabled.
AutoDeploy: Serverless GPU session access is enabled and necessary resources will be automatically setup.

SingleSignOnStatus

SingleSignOn (SSO) enable or disable status. Indicates whether Dev Boxes in the Pool will have SSO enabled or disabled.
KnownSingleSignOnStatus can be used interchangeably with SingleSignOnStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Single Sign On is disabled.
Enabled: Single Sign On is enabled.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

StopOnDisconnectEnableStatus

Stop on disconnect enable or disable status. Indicates whether stop on disconnect to is either enabled or disabled.
KnownStopOnDisconnectEnableStatus can be used interchangeably with StopOnDisconnectEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Stop on disconnect is enabled.
Disabled: Stop on disconnect is disabled.

StopOnNoConnectEnableStatus

Stop on no connect enable or disable status.
KnownStopOnNoConnectEnableStatus can be used interchangeably with StopOnNoConnectEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Stop on no connect is enabled.
Disabled: Stop on no connect is disabled.

UsageUnit

The unit details.
KnownUsageUnit can be used interchangeably with UsageUnit, this enum contains the known values that the service supports.

Known values supported by the service

Count: Count.

UserCustomizationsEnableStatus

Indicates whether user customizations are enabled.
KnownUserCustomizationsEnableStatus can be used interchangeably with UserCustomizationsEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: User customizations are disabled.
Enabled: User customizations are enabled.

VirtualNetworkType

Indicates a pool uses a Virtual Network managed by Microsoft (Managed), or a customer provided Network (Unmanaged).
KnownVirtualNetworkType can be used interchangeably with VirtualNetworkType, this enum contains the known values that the service supports.

Known values supported by the service

Managed: Virtual Network is managed by Microsoft.
Unmanaged: Virtual Network is managed by user.

WorkspaceStorageMode

Indicates whether workspace storage is enabled.
KnownWorkspaceStorageMode can be used interchangeably with WorkspaceStorageMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Workspace storage is disabled.
AutoDeploy: Workspace storage is enabled and necessary resources will be automatically setup.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownArchitectureType

Architecture Types.

KnownAssignedGroupScope

The scope of an assignment.

KnownAutoImageBuildStatus

Indicates whether auto image build is enabled/disabled.

KnownAutoStartEnableStatus

Enables or disables whether Dev Boxes should be automatically started at commencement of active hours.

KnownAzureAiServicesMode

Indicates whether Azure AI services are enabled for a project.

KnownCancelOnConnectEnableStatus

Indicates whether cancel on connect is enabled.

KnownCatalogAutoImageBuildEnableStatus

Indicates whether auto image build is enabled/disabled for image definitions in the catalog.

KnownCatalogConnectionState

The connection state of the catalog.

KnownCatalogItemSyncEnableStatus

Catalog item sync types enable or disable status. Indicates whether project catalogs are allowed to sync catalog items under projects associated to this dev center.

KnownCatalogItemType

Indicates catalog item types.

KnownCatalogResourceValidationStatus

Catalog resource validation status.

KnownCatalogSyncState

The synchronization state of the catalog.

KnownCatalogSyncType

Indicates the type of sync that is configured for the catalog.

KnownCheckNameAvailabilityReason

Possible reasons for a name not being available.

KnownCmkIdentityType

The type of identity used to access the key vault key.

KnownCreatedByType

The kind of entity that created the resource.

KnownCustomizationTaskInputType

Type of the input.

KnownDevBoxDeleteMode

Indicates possible values for Dev Box delete mode.

KnownDevboxDisksEncryptionEnableStatus

Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption is enabled or not.

KnownDevBoxTunnelEnableStatus

Indicates whether Dev Box Tunnel is enabled.

KnownDevCenterResourceType

Indicates dev center resource types.

KnownDomainJoinType

Active Directory join type.

KnownEnvironmentTypeEnableStatus

Indicates whether the environment type is either enabled or disabled.

KnownFeatureStateModifiable

Feature enablement status.

KnownFeatureStatus

Feature status.

KnownHealthCheckStatus

Health check status values.

KnownHealthStatus

Health status indicating whether a pool is available to create Dev Boxes.

KnownHibernateSupport

Indicates whether hibernate is enabled/disabled.

KnownIdentityType

The type of identity to use.

KnownImageDefinitionBuildStatus

The state of an Image Definition Build.

KnownImageValidationStatus

Image validation status.

KnownInstallAzureMonitorAgentEnableStatus

Setting to be used when determining whether to install the Azure Monitor Agent service on Dev Boxes that belong to this dev center.

KnownKeepAwakeEnableStatus

Enables or disables whether Dev Boxes should be kept awake during active hours.

KnownLicenseType

License Types

KnownLocalAdminStatus

Local Administrator enable or disable status. Indicates whether owners of Dev Boxes are added as local administrators on the Dev Box.

KnownManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

KnownMicrosoftHostedNetworkEnableStatus

Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownParameterType

The type of data a parameter accepts.

KnownPolicyAction

Indicates what action to perform for the policy.

KnownPoolDevBoxDefinitionType

Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.

KnownProjectCustomizationIdentityType

Values can be systemAssignedIdentity or userAssignedIdentity

KnownProvisioningState

Provisioning state of the resource.

KnownScheduledFrequency

The frequency of task execution.

KnownScheduledType

The supported types for a scheduled task.

KnownScheduleEnableStatus

Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled.

KnownServerlessGpuSessionsMode

Indicates whether serverless GPU session access is enabled.

KnownSingleSignOnStatus

SingleSignOn (SSO) enable or disable status. Indicates whether Dev Boxes in the Pool will have SSO enabled or disabled.

KnownStopOnDisconnectEnableStatus

Stop on disconnect enable or disable status. Indicates whether stop on disconnect to is either enabled or disabled.

KnownStopOnNoConnectEnableStatus

Stop on no connect enable or disable status.

KnownUsageUnit

The unit details.

KnownUserCustomizationsEnableStatus

Indicates whether user customizations are enabled.

KnownVersions

The available API versions.

KnownVirtualNetworkType

Indicates a pool uses a Virtual Network managed by Microsoft (Managed), or a customer provided Network (Unmanaged).

KnownWorkspaceStorageMode

Indicates whether workspace storage is enabled.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(DevCenterClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(DevCenterClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: DevCenterClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type