Status

List

get

Retrieve a list of templates with status information.

Query parameters
SiteIdinteger · int32Optional

Site ID for which the template with status information will be retrieved (optional)

NamestringOptional

Filter the result by name (optional)

Responses
chevron-right
200

Success

application/json; api-version=1.0

Template Status

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
namestring · nullableOptional

Template name.

providerIdinteger · int32Optional

Provider ID.

desktopIdstring · nullableOptional

Desktop ID.

statusstring · enumOptional

Type of template

Possible values:
powerStatestring · enumOptional

Power State

Possible values:
agentVerstring · nullableOptional

Last known Agent Version.

templateHasClonesbooleanOptional

Whether the template has clones.

agentStatusstring · enumOptional

Agent State

Possible values:
distributionstring · enumOptional

Type of distribution

Possible values:
templateVMExistbooleanOptional

Whether the template has VM.

get
/api/AVD/Template/Status

Get

get

Retrieve the template status information.

Path parameters
idinteger · int32Required

Template ID

Responses
chevron-right
200

Success

application/json; api-version=1.0

Template Status

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
namestring · nullableOptional

Template name.

providerIdinteger · int32Optional

Provider ID.

desktopIdstring · nullableOptional

Desktop ID.

statusstring · enumOptional

Type of template

Possible values:
powerStatestring · enumOptional

Power State

Possible values:
agentVerstring · nullableOptional

Last known Agent Version.

templateHasClonesbooleanOptional

Whether the template has clones.

agentStatusstring · enumOptional

Agent State

Possible values:
distributionstring · enumOptional

Type of distribution

Possible values:
templateVMExistbooleanOptional

Whether the template has VM.

get
/api/AVD/Template/{id}/Status

Was this helpful?