@azure/arm-devcenter package

Classes

DevCenterClient

Interfaces

AllowedEnvironmentType

Represents an allowed environment type.

AllowedEnvironmentTypeListResult

Result of the allowed environment type list operation.

AttachedNetworkConnection

Represents an attached NetworkConnection.

AttachedNetworkListResult

Results of the Attached Networks list operation.

AttachedNetworks

Interface representing a AttachedNetworks.

AttachedNetworksCreateOrUpdateOptionalParams

Optional parameters.

AttachedNetworksDeleteHeaders

Defines headers for AttachedNetworks_delete operation.

AttachedNetworksDeleteOptionalParams

Optional parameters.

AttachedNetworksGetByDevCenterOptionalParams

Optional parameters.

AttachedNetworksGetByProjectOptionalParams

Optional parameters.

AttachedNetworksListByDevCenterNextOptionalParams

Optional parameters.

AttachedNetworksListByDevCenterOptionalParams

Optional parameters.

AttachedNetworksListByProjectNextOptionalParams

Optional parameters.

AttachedNetworksListByProjectOptionalParams

Optional parameters.

Capability

A name/value pair to describe a capability.

Catalog

Represents a catalog.

CatalogConflictError

An individual conflict error.

CatalogErrorDetails

Catalog error details

CatalogListResult

Results of the catalog list operation.

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.

Catalogs

Interface representing a Catalogs.

CatalogsConnectHeaders

Defines headers for Catalogs_connect operation.

CatalogsConnectOptionalParams

Optional parameters.

CatalogsCreateOrUpdateOptionalParams

Optional parameters.

CatalogsDeleteHeaders

Defines headers for Catalogs_delete operation.

CatalogsDeleteOptionalParams

Optional parameters.

CatalogsGetOptionalParams

Optional parameters.

CatalogsGetSyncErrorDetailsOptionalParams

Optional parameters.

CatalogsListByDevCenterNextOptionalParams

Optional parameters.

CatalogsListByDevCenterOptionalParams

Optional parameters.

CatalogsSyncHeaders

Defines headers for Catalogs_sync operation.

CatalogsSyncOptionalParams

Optional parameters.

CatalogsUpdateHeaders

Defines headers for Catalogs_update operation.

CatalogsUpdateOptionalParams

Optional parameters.

CheckNameAvailability

Interface representing a CheckNameAvailability.

CheckNameAvailabilityExecuteOptionalParams

Optional parameters.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

CheckScopedNameAvailability

Interface representing a CheckScopedNameAvailability.

CheckScopedNameAvailabilityExecuteOptionalParams

Optional parameters.

CheckScopedNameAvailabilityRequest

The scoped name check availability request body.

CustomerManagedKeyEncryption

All 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.

DevBoxDefinition

Represents a definition for a Developer Machine.

DevBoxDefinitionListResult

Results of the Dev Box definition list operation.

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.

DevBoxDefinitions

Interface representing a DevBoxDefinitions.

DevBoxDefinitionsCreateOrUpdateOptionalParams

Optional parameters.

DevBoxDefinitionsDeleteHeaders

Defines headers for DevBoxDefinitions_delete operation.

DevBoxDefinitionsDeleteOptionalParams

Optional parameters.

DevBoxDefinitionsGetByProjectOptionalParams

Optional parameters.

DevBoxDefinitionsGetOptionalParams

Optional parameters.

DevBoxDefinitionsListByDevCenterNextOptionalParams

Optional parameters.

DevBoxDefinitionsListByDevCenterOptionalParams

Optional parameters.

DevBoxDefinitionsListByProjectNextOptionalParams

Optional parameters.

DevBoxDefinitionsListByProjectOptionalParams

Optional parameters.

DevBoxDefinitionsUpdateHeaders

Defines headers for DevBoxDefinitions_update operation.

DevBoxDefinitionsUpdateOptionalParams

Optional parameters.

DevCenter

Represents a devcenter resource.

DevCenterClientOptionalParams

Optional parameters.

DevCenterListResult

Result of the list devcenters operation

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.

DevCenters

Interface representing a DevCenters.

DevCentersCreateOrUpdateOptionalParams

Optional parameters.

DevCentersDeleteHeaders

Defines headers for DevCenters_delete operation.

DevCentersDeleteOptionalParams

Optional parameters.

DevCentersGetOptionalParams

Optional parameters.

DevCentersListByResourceGroupNextOptionalParams

Optional parameters.

DevCentersListByResourceGroupOptionalParams

Optional parameters.

DevCentersListBySubscriptionNextOptionalParams

Optional parameters.

DevCentersListBySubscriptionOptionalParams

Optional parameters.

DevCentersUpdateHeaders

Defines headers for DevCenters_update operation.

DevCentersUpdateOptionalParams

Optional parameters.

Encryption
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.

EnvironmentDefinitionListResult

Results of the environment definition list operation.

EnvironmentDefinitionParameter

Properties of an Environment Definition parameter

EnvironmentDefinitions

Interface representing a EnvironmentDefinitions.

EnvironmentDefinitionsGetByProjectCatalogOptionalParams

Optional parameters.

EnvironmentDefinitionsGetErrorDetailsOptionalParams

Optional parameters.

EnvironmentDefinitionsGetOptionalParams

Optional parameters.

EnvironmentDefinitionsListByCatalogNextOptionalParams

Optional parameters.

EnvironmentDefinitionsListByCatalogOptionalParams

Optional parameters.

EnvironmentDefinitionsListByProjectCatalogNextOptionalParams

Optional parameters.

EnvironmentDefinitionsListByProjectCatalogOptionalParams

Optional parameters.

EnvironmentRole

A role that can be assigned to a user.

EnvironmentType

Represents an environment type.

EnvironmentTypeListResult

Result of the environment type list operation.

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.

EnvironmentTypes

Interface representing a EnvironmentTypes.

EnvironmentTypesCreateOrUpdateOptionalParams

Optional parameters.

EnvironmentTypesDeleteOptionalParams

Optional parameters.

EnvironmentTypesGetOptionalParams

Optional parameters.

EnvironmentTypesListByDevCenterNextOptionalParams

Optional parameters.

EnvironmentTypesListByDevCenterOptionalParams

Optional parameters.

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. (This also follows the OData error response format.).

Galleries

Interface representing a Galleries.

GalleriesCreateOrUpdateOptionalParams

Optional parameters.

GalleriesDeleteHeaders

Defines headers for Galleries_delete operation.

GalleriesDeleteOptionalParams

Optional parameters.

GalleriesGetOptionalParams

Optional parameters.

GalleriesListByDevCenterNextOptionalParams

Optional parameters.

GalleriesListByDevCenterOptionalParams

Optional parameters.

Gallery

Represents a gallery.

GalleryListResult

Results of the gallery list operation.

GitCatalog

Properties for a Git repository catalog.

HealthCheck

An individual health check item

HealthCheckStatusDetails

Health Check details.

HealthCheckStatusDetailsListResult

Result of the network health check list operation.

HealthStatusDetail

Pool health status detail.

Image

Represents an image.

ImageListResult

Results of the image list operation.

ImageReference

Image reference information

ImageValidationErrorDetails

Image validation error details

ImageVersion

Represents an image version.

ImageVersionListResult

Results of the image version list operation.

ImageVersions

Interface representing a ImageVersions.

ImageVersionsGetOptionalParams

Optional parameters.

ImageVersionsListByImageNextOptionalParams

Optional parameters.

ImageVersionsListByImageOptionalParams

Optional parameters.

Images

Interface representing a Images.

ImagesGetOptionalParams

Optional parameters.

ImagesListByDevCenterNextOptionalParams

Optional parameters.

ImagesListByDevCenterOptionalParams

Optional parameters.

ImagesListByGalleryNextOptionalParams

Optional parameters.

ImagesListByGalleryOptionalParams

Optional parameters.

ListUsagesResult

List of Core Usages.

ManagedServiceIdentity

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

NetworkConnection

Network related settings

NetworkConnectionListResult

Result of the network connection list operation.

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.

NetworkConnections

Interface representing a NetworkConnections.

NetworkConnectionsCreateOrUpdateOptionalParams

Optional parameters.

NetworkConnectionsDeleteHeaders

Defines headers for NetworkConnections_delete operation.

NetworkConnectionsDeleteOptionalParams

Optional parameters.

NetworkConnectionsGetHealthDetailsOptionalParams

Optional parameters.

NetworkConnectionsGetOptionalParams

Optional parameters.

NetworkConnectionsListByResourceGroupNextOptionalParams

Optional parameters.

NetworkConnectionsListByResourceGroupOptionalParams

Optional parameters.

NetworkConnectionsListBySubscriptionNextOptionalParams

Optional parameters.

NetworkConnectionsListBySubscriptionOptionalParams

Optional parameters.

NetworkConnectionsListHealthDetailsOptionalParams

Optional parameters.

NetworkConnectionsListOutboundNetworkDependenciesEndpointsNextOptionalParams

Optional parameters.

NetworkConnectionsListOutboundNetworkDependenciesEndpointsOptionalParams

Optional parameters.

NetworkConnectionsRunHealthChecksHeaders

Defines headers for NetworkConnections_runHealthChecks operation.

NetworkConnectionsRunHealthChecksOptionalParams

Optional parameters.

NetworkConnectionsUpdateHeaders

Defines headers for NetworkConnections_update operation.

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 this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

OperationStatus

The current status of an async operation

OperationStatusResult

The current status of an async operation.

OperationStatuses

Interface representing a OperationStatuses.

OperationStatusesGetHeaders

Defines headers for OperationStatuses_get operation.

OperationStatusesGetOptionalParams

Optional parameters.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OutboundEnvironmentEndpoint

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

OutboundEnvironmentEndpointCollection

Values returned by the List operation.

Pool

A pool of Virtual Machines.

PoolListResult

Results of the machine pool list operation.

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.

Pools

Interface representing a Pools.

PoolsCreateOrUpdateOptionalParams

Optional parameters.

PoolsDeleteHeaders

Defines headers for Pools_delete operation.

PoolsDeleteOptionalParams

Optional parameters.

PoolsGetOptionalParams

Optional parameters.

PoolsListByProjectNextOptionalParams

Optional parameters.

PoolsListByProjectOptionalParams

Optional parameters.

PoolsRunHealthChecksHeaders

Defines headers for Pools_runHealthChecks operation.

PoolsRunHealthChecksOptionalParams

Optional parameters.

PoolsUpdateHeaders

Defines headers for Pools_update operation.

PoolsUpdateOptionalParams

Optional parameters.

Project

Represents a project resource.

ProjectAllowedEnvironmentTypes

Interface representing a ProjectAllowedEnvironmentTypes.

ProjectAllowedEnvironmentTypesGetOptionalParams

Optional parameters.

ProjectAllowedEnvironmentTypesListNextOptionalParams

Optional parameters.

ProjectAllowedEnvironmentTypesListOptionalParams

Optional parameters.

ProjectCatalogEnvironmentDefinitions

Interface representing a ProjectCatalogEnvironmentDefinitions.

ProjectCatalogEnvironmentDefinitionsGetErrorDetailsOptionalParams

Optional parameters.

ProjectCatalogSettings

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

ProjectCatalogs

Interface representing a ProjectCatalogs.

ProjectCatalogsConnectHeaders

Defines headers for ProjectCatalogs_connect operation.

ProjectCatalogsConnectOptionalParams

Optional parameters.

ProjectCatalogsCreateOrUpdateOptionalParams

Optional parameters.

ProjectCatalogsDeleteHeaders

Defines headers for ProjectCatalogs_delete operation.

ProjectCatalogsDeleteOptionalParams

Optional parameters.

ProjectCatalogsGetOptionalParams

Optional parameters.

ProjectCatalogsGetSyncErrorDetailsOptionalParams

Optional parameters.

ProjectCatalogsListNextOptionalParams

Optional parameters.

ProjectCatalogsListOptionalParams

Optional parameters.

ProjectCatalogsPatchHeaders

Defines headers for ProjectCatalogs_patch operation.

ProjectCatalogsPatchOptionalParams

Optional parameters.

ProjectCatalogsSyncHeaders

Defines headers for ProjectCatalogs_sync operation.

ProjectCatalogsSyncOptionalParams

Optional parameters.

ProjectEnvironmentType

Represents an environment type.

ProjectEnvironmentTypeListResult

Result of the project environment type list operation.

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.

ProjectEnvironmentTypes

Interface representing a ProjectEnvironmentTypes.

ProjectEnvironmentTypesCreateOrUpdateOptionalParams

Optional parameters.

ProjectEnvironmentTypesDeleteOptionalParams

Optional parameters.

ProjectEnvironmentTypesGetOptionalParams

Optional parameters.

ProjectEnvironmentTypesListNextOptionalParams

Optional parameters.

ProjectEnvironmentTypesListOptionalParams

Optional parameters.

ProjectEnvironmentTypesUpdateOptionalParams

Optional parameters.

ProjectListResult

Results of the project list operation.

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.

Projects

Interface representing a Projects.

ProjectsCreateOrUpdateOptionalParams

Optional parameters.

ProjectsDeleteHeaders

Defines headers for Projects_delete operation.

ProjectsDeleteOptionalParams

Optional parameters.

ProjectsGetOptionalParams

Optional parameters.

ProjectsListByResourceGroupNextOptionalParams

Optional parameters.

ProjectsListByResourceGroupOptionalParams

Optional parameters.

ProjectsListBySubscriptionNextOptionalParams

Optional parameters.

ProjectsListBySubscriptionOptionalParams

Optional parameters.

ProjectsUpdateHeaders

Defines headers for Projects_update operation.

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

ResourceRange

Properties for a range of values.

Schedule

Represents a Schedule to execute a task.

ScheduleListResult

Result of the schedule list operation.

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.

Schedules

Interface representing a Schedules.

SchedulesCreateOrUpdateOptionalParams

Optional parameters.

SchedulesDeleteHeaders

Defines headers for Schedules_delete operation.

SchedulesDeleteOptionalParams

Optional parameters.

SchedulesGetOptionalParams

Optional parameters.

SchedulesListByPoolNextOptionalParams

Optional parameters.

SchedulesListByPoolOptionalParams

Optional parameters.

SchedulesUpdateHeaders

Defines headers for Schedules_update operation.

SchedulesUpdateOptionalParams

Optional parameters.

Sku

The resource model definition representing SKU

SkuListResult

Results of the Microsoft.DevCenter SKU list operation.

Skus

Interface representing a Skus.

SkusListBySubscriptionNextOptionalParams

Optional parameters.

SkusListBySubscriptionOptionalParams

Optional parameters.

StopOnDisconnectConfiguration

Stop on disconnect 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'

TrackedResourceUpdate

Base tracked resource type for PATCH updates

Usage

The core usage details.

UsageName

The Usage Names.

Usages

Interface representing a Usages.

UsagesListByLocationNextOptionalParams

Optional parameters.

UsagesListByLocationOptionalParams

Optional parameters.

UserAssignedIdentity

User assigned identity properties

UserRoleAssignmentValue

Mapping of user object ID to role assignments.

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

AttachedNetworksCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AttachedNetworksDeleteResponse

Contains response data for the delete operation.

AttachedNetworksGetByDevCenterResponse

Contains response data for the getByDevCenter operation.

AttachedNetworksGetByProjectResponse

Contains response data for the getByProject operation.

AttachedNetworksListByDevCenterNextResponse

Contains response data for the listByDevCenterNext operation.

AttachedNetworksListByDevCenterResponse

Contains response data for the listByDevCenter operation.

AttachedNetworksListByProjectNextResponse

Contains response data for the listByProjectNext operation.

AttachedNetworksListByProjectResponse

Contains response data for the listByProject operation.

CatalogConnectionState

Defines values for CatalogConnectionState.
KnownCatalogConnectionState can be used interchangeably with CatalogConnectionState, this enum contains the known values that the service supports.

Known values supported by the service

Connected
Disconnected

CatalogItemSyncEnableStatus

Defines values for CatalogItemSyncEnableStatus.
KnownCatalogItemSyncEnableStatus can be used interchangeably with CatalogItemSyncEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

CatalogItemType

Defines values for CatalogItemType.
KnownCatalogItemType can be used interchangeably with CatalogItemType, this enum contains the known values that the service supports.

Known values supported by the service

EnvironmentDefinition

CatalogResourceValidationStatus

Defines values for CatalogResourceValidationStatus.
KnownCatalogResourceValidationStatus can be used interchangeably with CatalogResourceValidationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Pending
Succeeded
Failed

CatalogSyncState

Defines values for CatalogSyncState.
KnownCatalogSyncState can be used interchangeably with CatalogSyncState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
InProgress
Failed
Canceled

CatalogSyncType

Defines values for CatalogSyncType.
KnownCatalogSyncType can be used interchangeably with CatalogSyncType, this enum contains the known values that the service supports.

Known values supported by the service

Manual
Scheduled

CatalogsConnectResponse

Contains response data for the connect operation.

CatalogsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

CatalogsDeleteResponse

Contains response data for the delete operation.

CatalogsGetResponse

Contains response data for the get operation.

CatalogsGetSyncErrorDetailsResponse

Contains response data for the getSyncErrorDetails operation.

CatalogsListByDevCenterNextResponse

Contains response data for the listByDevCenterNext operation.

CatalogsListByDevCenterResponse

Contains response data for the listByDevCenter operation.

CatalogsSyncResponse

Contains response data for the sync operation.

CatalogsUpdateResponse

Contains response data for the update operation.

CheckNameAvailabilityExecuteResponse

Contains response data for the execute operation.

CheckNameAvailabilityReason

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

CheckScopedNameAvailabilityExecuteResponse

Contains response data for the execute operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DevBoxDefinitionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DevBoxDefinitionsDeleteResponse

Contains response data for the delete operation.

DevBoxDefinitionsGetByProjectResponse

Contains response data for the getByProject operation.

DevBoxDefinitionsGetResponse

Contains response data for the get operation.

DevBoxDefinitionsListByDevCenterNextResponse

Contains response data for the listByDevCenterNext operation.

DevBoxDefinitionsListByDevCenterResponse

Contains response data for the listByDevCenter operation.

DevBoxDefinitionsListByProjectNextResponse

Contains response data for the listByProjectNext operation.

DevBoxDefinitionsListByProjectResponse

Contains response data for the listByProject operation.

DevBoxDefinitionsUpdateResponse

Contains response data for the update operation.

DevCentersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DevCentersDeleteResponse

Contains response data for the delete operation.

DevCentersGetResponse

Contains response data for the get operation.

DevCentersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

DevCentersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

DevCentersListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

DevCentersListBySubscriptionResponse

Contains response data for the listBySubscription operation.

DevCentersUpdateResponse

Contains response data for the update operation.

DomainJoinType

Defines values for DomainJoinType.
KnownDomainJoinType can be used interchangeably with DomainJoinType, this enum contains the known values that the service supports.

Known values supported by the service

HybridAzureADJoin
AzureADJoin

EnvironmentDefinitionsGetByProjectCatalogResponse

Contains response data for the getByProjectCatalog operation.

EnvironmentDefinitionsGetErrorDetailsResponse

Contains response data for the getErrorDetails operation.

EnvironmentDefinitionsGetResponse

Contains response data for the get operation.

EnvironmentDefinitionsListByCatalogNextResponse

Contains response data for the listByCatalogNext operation.

EnvironmentDefinitionsListByCatalogResponse

Contains response data for the listByCatalog operation.

EnvironmentDefinitionsListByProjectCatalogNextResponse

Contains response data for the listByProjectCatalogNext operation.

EnvironmentDefinitionsListByProjectCatalogResponse

Contains response data for the listByProjectCatalog operation.

EnvironmentTypeEnableStatus

Defines values for EnvironmentTypeEnableStatus.
KnownEnvironmentTypeEnableStatus can be used interchangeably with EnvironmentTypeEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

EnvironmentTypesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

EnvironmentTypesGetResponse

Contains response data for the get operation.

EnvironmentTypesListByDevCenterNextResponse

Contains response data for the listByDevCenterNext operation.

EnvironmentTypesListByDevCenterResponse

Contains response data for the listByDevCenter operation.

EnvironmentTypesUpdateResponse

Contains response data for the update operation.

GalleriesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GalleriesDeleteResponse

Contains response data for the delete operation.

GalleriesGetResponse

Contains response data for the get operation.

GalleriesListByDevCenterNextResponse

Contains response data for the listByDevCenterNext operation.

GalleriesListByDevCenterResponse

Contains response data for the listByDevCenter operation.

HealthCheckStatus

Defines values for HealthCheckStatus.
KnownHealthCheckStatus can be used interchangeably with HealthCheckStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Pending
Running
Passed
Warning
Failed

HealthStatus

Defines values for HealthStatus.
KnownHealthStatus can be used interchangeably with HealthStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Pending
Healthy
Warning
Unhealthy

HibernateSupport

Defines values for HibernateSupport.
KnownHibernateSupport can be used interchangeably with HibernateSupport, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

IdentityType

Defines values for IdentityType.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

systemAssignedIdentity
userAssignedIdentity
delegatedResourceIdentity

ImageValidationStatus

Defines values for ImageValidationStatus.
KnownImageValidationStatus can be used interchangeably with ImageValidationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Pending
Succeeded
Failed
TimedOut

ImageVersionsGetResponse

Contains response data for the get operation.

ImageVersionsListByImageNextResponse

Contains response data for the listByImageNext operation.

ImageVersionsListByImageResponse

Contains response data for the listByImage operation.

ImagesGetResponse

Contains response data for the get operation.

ImagesListByDevCenterNextResponse

Contains response data for the listByDevCenterNext operation.

ImagesListByDevCenterResponse

Contains response data for the listByDevCenter operation.

ImagesListByGalleryNextResponse

Contains response data for the listByGalleryNext operation.

ImagesListByGalleryResponse

Contains response data for the listByGallery operation.

LicenseType

Defines values for LicenseType.
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

LocalAdminStatus

Defines values for LocalAdminStatus.
KnownLocalAdminStatus can be used interchangeably with LocalAdminStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

NetworkConnectionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NetworkConnectionsDeleteResponse

Contains response data for the delete operation.

NetworkConnectionsGetHealthDetailsResponse

Contains response data for the getHealthDetails operation.

NetworkConnectionsGetResponse

Contains response data for the get operation.

NetworkConnectionsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

NetworkConnectionsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

NetworkConnectionsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

NetworkConnectionsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

NetworkConnectionsListHealthDetailsResponse

Contains response data for the listHealthDetails operation.

NetworkConnectionsListOutboundNetworkDependenciesEndpointsNextResponse

Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.

NetworkConnectionsListOutboundNetworkDependenciesEndpointsResponse

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

NetworkConnectionsRunHealthChecksResponse

Contains response data for the runHealthChecks operation.

NetworkConnectionsUpdateResponse

Contains response data for the update operation.

OperationStatusesGetResponse

Contains response data for the get operation.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ParameterType

Defines values for ParameterType.
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.

PoolsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PoolsDeleteResponse

Contains response data for the delete operation.

PoolsGetResponse

Contains response data for the get operation.

PoolsListByProjectNextResponse

Contains response data for the listByProjectNext operation.

PoolsListByProjectResponse

Contains response data for the listByProject operation.

PoolsRunHealthChecksResponse

Contains response data for the runHealthChecks operation.

PoolsUpdateResponse

Contains response data for the update operation.

ProjectAllowedEnvironmentTypesGetResponse

Contains response data for the get operation.

ProjectAllowedEnvironmentTypesListNextResponse

Contains response data for the listNext operation.

ProjectAllowedEnvironmentTypesListResponse

Contains response data for the list operation.

ProjectCatalogEnvironmentDefinitionsGetErrorDetailsResponse

Contains response data for the getErrorDetails operation.

ProjectCatalogsConnectResponse

Contains response data for the connect operation.

ProjectCatalogsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProjectCatalogsDeleteResponse

Contains response data for the delete operation.

ProjectCatalogsGetResponse

Contains response data for the get operation.

ProjectCatalogsGetSyncErrorDetailsResponse

Contains response data for the getSyncErrorDetails operation.

ProjectCatalogsListNextResponse

Contains response data for the listNext operation.

ProjectCatalogsListResponse

Contains response data for the list operation.

ProjectCatalogsPatchResponse

Contains response data for the patch operation.

ProjectCatalogsSyncResponse

Contains response data for the sync operation.

ProjectEnvironmentTypesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProjectEnvironmentTypesGetResponse

Contains response data for the get operation.

ProjectEnvironmentTypesListNextResponse

Contains response data for the listNext operation.

ProjectEnvironmentTypesListResponse

Contains response data for the list operation.

ProjectEnvironmentTypesUpdateResponse

Contains response data for the update operation.

ProjectsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProjectsDeleteResponse

Contains response data for the delete operation.

ProjectsGetResponse

Contains response data for the get operation.

ProjectsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ProjectsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ProjectsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ProjectsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ProjectsUpdateResponse

Contains response data for the update operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

NotSpecified
Accepted
Running
Creating
Created
Updating
Updated
Deleting
Deleted
Succeeded
Failed
Canceled
MovingResources
TransientFailure
RolloutInProgress
StorageProvisioningFailed

ScheduleEnableStatus

Defines values for ScheduleEnableStatus.
KnownScheduleEnableStatus can be used interchangeably with ScheduleEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

ScheduledFrequency

Defines values for ScheduledFrequency.
KnownScheduledFrequency can be used interchangeably with ScheduledFrequency, this enum contains the known values that the service supports.

Known values supported by the service

Daily

ScheduledType

Defines values for ScheduledType.
KnownScheduledType can be used interchangeably with ScheduledType, this enum contains the known values that the service supports.

Known values supported by the service

StopDevBox

SchedulesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

SchedulesDeleteResponse

Contains response data for the delete operation.

SchedulesGetResponse

Contains response data for the get operation.

SchedulesListByPoolNextResponse

Contains response data for the listByPoolNext operation.

SchedulesListByPoolResponse

Contains response data for the listByPool operation.

SchedulesUpdateResponse

Contains response data for the update operation.

SingleSignOnStatus

Defines values for SingleSignOnStatus.
KnownSingleSignOnStatus can be used interchangeably with SingleSignOnStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

SkuTier

Defines values for SkuTier.

SkusListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

SkusListBySubscriptionResponse

Contains response data for the listBySubscription operation.

StopOnDisconnectEnableStatus

Defines values for StopOnDisconnectEnableStatus.
KnownStopOnDisconnectEnableStatus can be used interchangeably with StopOnDisconnectEnableStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

UsageUnit

Defines values for UsageUnit.
KnownUsageUnit can be used interchangeably with UsageUnit, this enum contains the known values that the service supports.

Known values supported by the service

Count

UsagesListByLocationNextResponse

Contains response data for the listByLocationNext operation.

UsagesListByLocationResponse

Contains response data for the listByLocation operation.

VirtualNetworkType

Defines values for VirtualNetworkType.
KnownVirtualNetworkType can be used interchangeably with VirtualNetworkType, this enum contains the known values that the service supports.

Known values supported by the service

Managed
Unmanaged

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCatalogConnectionState

Known values of CatalogConnectionState that the service accepts.

KnownCatalogItemSyncEnableStatus

Known values of CatalogItemSyncEnableStatus that the service accepts.

KnownCatalogItemType

Known values of CatalogItemType that the service accepts.

KnownCatalogResourceValidationStatus

Known values of CatalogResourceValidationStatus that the service accepts.

KnownCatalogSyncState

Known values of CatalogSyncState that the service accepts.

KnownCatalogSyncType

Known values of CatalogSyncType that the service accepts.

KnownCheckNameAvailabilityReason

Known values of CheckNameAvailabilityReason that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDomainJoinType

Known values of DomainJoinType that the service accepts.

KnownEnvironmentTypeEnableStatus

Known values of EnvironmentTypeEnableStatus that the service accepts.

KnownHealthCheckStatus

Known values of HealthCheckStatus that the service accepts.

KnownHealthStatus

Known values of HealthStatus that the service accepts.

KnownHibernateSupport

Known values of HibernateSupport that the service accepts.

KnownIdentityType

Known values of IdentityType that the service accepts.

KnownImageValidationStatus

Known values of ImageValidationStatus that the service accepts.

KnownLicenseType

Known values of LicenseType that the service accepts.

KnownLocalAdminStatus

Known values of LocalAdminStatus that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownParameterType

Known values of ParameterType that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownScheduleEnableStatus

Known values of ScheduleEnableStatus that the service accepts.

KnownScheduledFrequency

Known values of ScheduledFrequency that the service accepts.

KnownScheduledType

Known values of ScheduledType that the service accepts.

KnownSingleSignOnStatus

Known values of SingleSignOnStatus that the service accepts.

KnownStopOnDisconnectEnableStatus

Known values of StopOnDisconnectEnableStatus that the service accepts.

KnownUsageUnit

Known values of UsageUnit that the service accepts.

KnownVirtualNetworkType

Known values of VirtualNetworkType that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.