Status

List

Retrieves a list of AVD Workspaces status information.

GET/api/AVD/Workspace/status

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

namenullable string

AVD Host Pool name.

providerIdinteger (int32)

Provider Id.

resourceGroupnullable string

Resource Group.

locationnullable string

Location.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

brokenReasonAVDBrokenReason (enum)

AVD Broken Reason

0 = MissingObj,1 = InvalidTags,2 = MissingDAGObj,3 = InvalidDAGTags,4 = MissingDAGRoles,5 = MissingDAGWorkspaceLink,6 = HostpoolAutomaticAssignment,7 = MissingRAGObj,8 = InvalidRAGTags,9 = MissingRAGRoles,10 = MissingRAGWorkspaceLink,11 = MissingRAGRemoteApp,12 = MissingObjectID,-1 = Ignore

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/Workspace/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[
  {
    "id": "text",
    "siteId": 0,
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "name": "text",
    "providerId": 0,
    "resourceGroup": "text",
    "location": "text",
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "brokenReason": [
      "0 = MissingObj",
      "1 = InvalidTags",
      "2 = MissingDAGObj",
      "3 = InvalidDAGTags",
      "4 = MissingDAGRoles",
      "5 = MissingDAGWorkspaceLink",
      "6 = HostpoolAutomaticAssignment",
      "7 = MissingRAGObj",
      "8 = InvalidRAGTags",
      "9 = MissingRAGRoles",
      "10 = MissingRAGWorkspaceLink",
      "11 = MissingRAGRemoteApp",
      "12 = MissingObjectID",
      "-1 = Ignore"
    ]
  }
]

Get

Retrieve the AVD Workspace status information.

GET/api/AVD/Workspace/{id}/status

Path parameters

id*integer (int32)

AVD Workspace ID

Response

200400401

Success

Body

application/json; api-version=1.0

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

namenullable string

AVD Host Pool name.

providerIdinteger (int32)

Provider Id.

resourceGroupnullable string

Resource Group.

locationnullable string

Location.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

brokenReasonAVDBrokenReason (enum)

AVD Broken Reason

0 = MissingObj,1 = InvalidTags,2 = MissingDAGObj,3 = InvalidDAGTags,4 = MissingDAGRoles,5 = MissingDAGWorkspaceLink,6 = HostpoolAutomaticAssignment,7 = MissingRAGObj,8 = InvalidRAGTags,9 = MissingRAGRoles,10 = MissingRAGWorkspaceLink,11 = MissingRAGRemoteApp,12 = MissingObjectID,-1 = Ignore

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/Workspace/{id}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "id": "text",
  "siteId": 0,
  "serverType": [
    "1 = RDSHost",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = PA",
    "9 = Site",
    "16 = RDSGroup",
    "25 = HALBDevice",
    "45 = TenantBroker",
    "46 = Enrollment",
    "51 = HALB",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "95 = VDITemplateVersion",
    "96 = AVDTemplateVersion",
    "97 = RDSTemplateVersion",
    "107 = RDSTemplate",
    "108 = VDITemplate",
    "2013 = VDIHost",
    "-1 = All"
  ],
  "name": "text",
  "providerId": 0,
  "resourceGroup": "text",
  "location": "text",
  "agentState": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ],
  "brokenReason": [
    "0 = MissingObj",
    "1 = InvalidTags",
    "2 = MissingDAGObj",
    "3 = InvalidDAGTags",
    "4 = MissingDAGRoles",
    "5 = MissingDAGWorkspaceLink",
    "6 = HostpoolAutomaticAssignment",
    "7 = MissingRAGObj",
    "8 = InvalidRAGTags",
    "9 = MissingRAGRoles",
    "10 = MissingRAGWorkspaceLink",
    "11 = MissingRAGRemoteApp",
    "12 = MissingObjectID",
    "-1 = Ignore"
  ]
}