@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. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| ArchitectureType |
Architecture Types. Known values supported by the servicex64: x64 architecture |
| AssignedGroupScope |
The scope of an assignment. Known values supported by the serviceDevBox: Assignment entitles group members to Dev Boxes in the Project. |
| AutoImageBuildStatus |
Indicates whether auto image build is enabled/disabled. Known values supported by the serviceDisabled: Auto image build is disabled. |
| AutoStartEnableStatus |
Enables or disables whether Dev Boxes should be automatically started at commencement of active hours. Known values supported by the serviceEnabled: Auto start is enabled. |
| AzureAiServicesMode |
Indicates whether Azure AI services are enabled for a project. Known values supported by the serviceDisabled: Azure AI services are disabled for this project. |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| CancelOnConnectEnableStatus |
Indicates whether cancel on connect is enabled. Known values supported by the serviceEnabled: Cancel on connect is enabled. |
| CatalogAutoImageBuildEnableStatus |
Indicates whether auto image build is enabled/disabled for image definitions in the catalog. Known values supported by the serviceDisabled: Auto image build is disabled. |
| CatalogConnectionState |
The connection state of the catalog. Known values supported by the serviceConnected: Connected 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. Known values supported by the serviceEnabled: Catalog item sync is enabled. |
| CatalogItemType |
Indicates catalog item types. Known values supported by the serviceEnvironmentDefinition: Environment definition catalog item type. |
| CatalogResourceValidationStatus |
Catalog resource validation status. Known values supported by the serviceUnknown: Unknown validation status. |
| CatalogSyncState |
The synchronization state of the catalog. Known values supported by the serviceSucceeded: Succeeded synchronization state. |
| CatalogSyncType |
Indicates the type of sync that is configured for the catalog. Known values supported by the serviceManual: Manual sync type. |
| CheckNameAvailabilityReason |
Possible reasons for a name not being available. Known values supported by the serviceInvalid: Name is invalid. |
| CmkIdentityType |
The type of identity used to access the key vault key. Known values supported by the serviceSystemAssigned: System assigned identity type. |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| CustomizationTaskInputType |
Type of the input. Known values supported by the servicestring: The parameter accepts a string value. |
| DayOfWeek |
The days of the week. |
| DevBoxDeleteMode |
Indicates possible values for Dev Box delete mode. Known values supported by the serviceManual: Dev Boxes will not be deleted automatically, and user must manually delete. This is the default. |
| DevBoxTunnelEnableStatus |
Indicates whether Dev Box Tunnel is enabled. Known values supported by the serviceDisabled: Dev Box Tunnel is enabled. |
| DevCenterResourceType |
Indicates dev center resource types. Known values supported by the serviceImages: Images resource type. |
| DevboxDisksEncryptionEnableStatus |
Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption is enabled or not. Known values supported by the serviceEnabled: Devbox disks encryption is enabled. |
| DomainJoinType |
Active Directory join type. Known values supported by the serviceHybridAzureADJoin: Hybrid Azure AD Join type. |
| EnvironmentTypeEnableStatus |
Indicates whether the environment type is either enabled or disabled. Known values supported by the serviceEnabled: Environment type is enabled. |
| FeatureStateModifiable |
Feature enablement status. Known values supported by the serviceNotModifiable: Feature is not modifiable. |
| FeatureStatus |
Feature status. Known values supported by the serviceEnabled: Feature is enabled. |
| HealthCheckStatus |
Health check status values. Known values supported by the serviceUnknown: Unknown health check status. |
| HealthStatus |
Health status indicating whether a pool is available to create Dev Boxes. Known values supported by the serviceUnknown: Unknown health status. |
| HibernateSupport |
Indicates whether hibernate is enabled/disabled. Known values supported by the serviceDisabled: Hibernate is disabled. |
| IdentityType |
The type of identity to use. Known values supported by the servicesystemAssignedIdentity: System assigned identity |
| ImageDefinitionBuildStatus |
The state of an Image Definition Build. Known values supported by the serviceSucceeded: The image build has succeeded. |
| ImageValidationStatus |
Image validation status. Known values supported by the serviceUnknown: Unknown 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. Known values supported by the serviceEnabled: Azure Monitor Agent service is enabled. |
| KeepAwakeEnableStatus |
Enables or disables whether Dev Boxes should be kept awake during active hours. Known values supported by the serviceEnabled: Keep awake is enabled. |
| LicenseType |
License Types Known values supported by the serviceWindows_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. Known values supported by the serviceDisabled: Local administrator is disabled. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| MicrosoftHostedNetworkEnableStatus |
Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set. Known values supported by the serviceEnabled: Microsoft Hosted Networks are enabled 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" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| ParameterType |
The type of data a parameter accepts. Known values supported by the servicearray: The parameter accepts an array of values. |
| PolicyAction |
Indicates what action to perform for the policy. Known values supported by the serviceAllow: Allow action for the policy. |
| PoolDevBoxDefinitionType |
Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly. Known values supported by the serviceReference: Indicates the pool is created from an existing Dev Box definition. |
| ProjectCustomizationIdentityType |
Values can be systemAssignedIdentity or userAssignedIdentity Known values supported by the servicesystemAssignedIdentity: System assigned identity type. |
| ProvisioningState |
Provisioning state of the resource. Known values supported by the serviceNotSpecified: Not specified provisioning state. |
| ScheduleEnableStatus |
Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled. Known values supported by the serviceEnabled: Schedule is enabled. |
| ScheduledFrequency |
The frequency of task execution. Known values supported by the serviceDaily: The scheduled task will run daily. |
| ScheduledType |
The supported types for a scheduled task. Known values supported by the serviceStopDevBox: Stop Dev Box task type. |
| ServerlessGpuSessionsMode |
Indicates whether serverless GPU session access is enabled. Known values supported by the serviceDisabled: Serverless GPU session access is disabled. |
| SingleSignOnStatus |
SingleSignOn (SSO) enable or disable status. Indicates whether Dev Boxes in the Pool will have SSO enabled or disabled. Known values supported by the serviceDisabled: Single Sign On is disabled. |
| 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. Known values supported by the serviceEnabled: Stop on disconnect is enabled. |
| StopOnNoConnectEnableStatus |
Stop on no connect enable or disable status. Known values supported by the serviceEnabled: Stop on no connect is enabled. |
| UsageUnit |
The unit details. Known values supported by the serviceCount: Count. |
| UserCustomizationsEnableStatus |
Indicates whether user customizations are enabled. Known values supported by the serviceDisabled: User customizations are disabled. |
| VirtualNetworkType |
Indicates a pool uses a Virtual Network managed by Microsoft (Managed), or a customer provided Network (Unmanaged). Known values supported by the serviceManaged: Virtual Network is managed by Microsoft. |
| WorkspaceStorageMode |
Indicates whether workspace storage is enabled. Known values supported by the serviceDisabled: Workspace storage is disabled. |
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
| is |
Typeguard for RestError |
| restore |
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
| Rest |
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
- client
- DevCenterClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor