Vmresource - List

Service:

Environments

API Version:

7.2-preview.1

Get Virtual Machine Resources

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines?api-version=7.2-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines?name={name}&tags={tags}&continuationToken={continuationToken}&$top={$top}&api-version=7.2-preview.1

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	integer (int32)	Id of the Environment
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.
$top	query		integer (int32)	Number of Virtual Machine Resources to get. Default is 1000.
continuationToken	query		string	Gets the Virtual Machine Resources after the continuation token provided.
name	query		string	Name of the Virtual Machine Resource
tags	query		string (array (string))	Tags of the Virtual Machine Resource

Responses

Name	Type	Description
200 OK	VirtualMachineResource[]	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.environment_manage	Provides ability to manage environment
vso.build	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.

Definitions

Name	Description
Demand
EnvironmentReference
EnvironmentResourceType	Type of the resource.
IdentityRef
PackageVersion
PropertiesCollection
ReferenceLinks
TaskAgent	A task agent.
TaskAgentAuthorization	Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows.
TaskAgentCloudRequest
TaskAgentJobRequest	A job request for an agent.
TaskAgentPoolOptions	Additional pool settings and details
TaskAgentPoolReference
TaskAgentPoolType	Gets or sets the type of the pool
TaskAgentPublicKey	Represents the public key portion of an RSA asymmetric key.
TaskAgentReference	A reference to an agent.
TaskAgentStatus	Whether or not the agent is online.
TaskAgentUpdate	Details about an agent update.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	Result of the environment deployment execution
VirtualMachineResource

Demand

Object

Name	Type	Description
name	string
value	string

EnvironmentReference

Object

Name	Type	Description
id	integer (int32)
name	string

EnvironmentResourceType

Enumeration

Type of the resource.

Value	Description
generic	Unknown resource type
kubernetes	Kubernetes resource type
undefined
virtualMachine	Virtual machine resource type

IdentityRef

Object

Name	Type	Description
_links	ReferenceLinks
descriptor	string
directoryAlias	string
displayName	string
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string

PackageVersion

Object

Name	Type	Description
major	integer (int32)
minor	integer (int32)
patch	integer (int32)

PropertiesCollection

Object

Name	Type	Description
count	integer (int32)
item	object
keys	string[]
values	string[]

ReferenceLinks

Object

Name	Type	Description
links	object

TaskAgent

Object

A task agent.

Name	Type	Description
_links	ReferenceLinks
accessPoint	string	This agent's access point.
assignedAgentCloudRequest	TaskAgentCloudRequest	The agent cloud request that's currently associated with this agent.
assignedRequest	TaskAgentJobRequest	The request which is currently assigned to this agent.
authorization	TaskAgentAuthorization	Authorization information for this agent.
createdOn	string (date-time)	Date on which this agent was created.
enabled	boolean	Whether or not this agent should run jobs.
id	integer (int32)	Identifier of the agent.
lastCompletedRequest	TaskAgentJobRequest	The last request which was completed by this agent.
maxParallelism	integer (int32)	Maximum job parallelism allowed for this agent.
name	string	Name of the agent.
osDescription	string	Agent OS.
pendingUpdate	TaskAgentUpdate	Pending update for this agent.
properties	PropertiesCollection
provisioningState	string	Provisioning state of this agent.
status	TaskAgentStatus	Whether or not the agent is online.
statusChangedOn	string (date-time)	Date on which the last connectivity status change occurred.
systemCapabilities	object	System-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.
userCapabilities	object	User-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.
version	string	Agent version.

TaskAgentAuthorization

Object

Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows.

Name	Type	Description
authorizationUrl	string	Endpoint used to obtain access tokens from the configured token service.
clientId	string (uuid)	Client identifier for this agent.
publicKey	TaskAgentPublicKey	Public key used to verify the identity of this agent.

TaskAgentCloudRequest

Object

Name	Type	Description
agent	TaskAgentReference	A reference to an agent.
agentCloudId	integer (int32)
agentConnectedTime	string (date-time)
agentData	string (JObject)
agentSpecification	string (JObject)
pool	TaskAgentPoolReference
poolProvidersTags	object
provisionRequestTime	string (date-time)
provisionedTime	string (date-time)
releaseRequestTime	string (date-time)
requestId	string (uuid)
requestVersion	integer (int32)

TaskAgentJobRequest

Object

A job request for an agent.

Name	Type	Description
agentSpecification	string (JObject)
assignTime	string (date-time)	The date/time this request was assigned.
data	object	Additional data about the request.
definition	TaskOrchestrationOwner	The pipeline definition associated with this request
demands	Demand[]	A list of demands required to fulfill this request.
finishTime	string (date-time)	The date/time this request was finished.
hostId	string (uuid)	The host which triggered this request.
jobId	string (uuid)	ID of the job resulting from this request.
jobName	string	Name of the job resulting from this request.
lockedUntil	string (date-time)	The deadline for the agent to renew the lock.
matchedAgents	TaskAgentReference[]	A reference to an agent.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	The pipeline associated with this request
planGroup	string
planId	string (uuid)	Internal ID for the orchestration plan connected with this request.
planType	string	Internal detail representing the type of orchestration plan.
poolId	integer (int32)	The ID of the pool this request targets
priority	integer (int32)
queueId	integer (int32)	The ID of the queue this request targets
queueTime	string (date-time)	The date/time this request was queued.
receiveTime	string (date-time)	The date/time this request was receieved by an agent.
requestId	integer (int64)	ID of the request.
reservedAgent	TaskAgentReference	The agent allocated for this request.
result	TaskResult	The result of this request.
scopeId	string (uuid)	Scope of the pipeline; matches the project ID.
serviceOwner	string (uuid)	The service which owns this request.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Enumeration

Additional pool settings and details

Value	Description
elasticPool	TaskAgentPool backed by the Elastic pool service
none
preserveAgentOnJobFailure	Set to true if agents are held for investigation after a TaskAgentJobRequest failure
singleUseAgents	Set to true if agents are re-imaged after each TaskAgentJobRequest

TaskAgentPoolReference

Object

Name	Type	Description
id	integer (int32)
isHosted	boolean	Gets or sets a value indicating whether or not this pool is managed by the service.
isLegacy	boolean	Determines whether the pool is legacy.
name	string
options	TaskAgentPoolOptions	Additional pool settings and details
poolType	TaskAgentPoolType	Gets or sets the type of the pool
scope	string (uuid)
size	integer (int32)	Gets the current size of the pool.

TaskAgentPoolType

Enumeration

Gets or sets the type of the pool

Value	Description
automation	A typical pool of task agents
deployment	A deployment pool

TaskAgentPublicKey

Object

Represents the public key portion of an RSA asymmetric key.

Name	Type	Description
exponent	string[] (byte)	Gets or sets the exponent for the public key.
modulus	string[] (byte)	Gets or sets the modulus for the public key.

TaskAgentReference

Object

A reference to an agent.

Name	Type	Description
_links	ReferenceLinks
accessPoint	string	This agent's access point.
enabled	boolean	Whether or not this agent should run jobs.
id	integer (int32)	Identifier of the agent.
name	string	Name of the agent.
osDescription	string	Agent OS.
provisioningState	string	Provisioning state of this agent.
status	TaskAgentStatus	Whether or not the agent is online.
version	string	Agent version.

TaskAgentStatus

Enumeration

Whether or not the agent is online.

Value	Description
offline
online

TaskAgentUpdate

Object

Details about an agent update.

Name	Type	Description
currentState	string	Current state of this agent update.
reason	TaskAgentUpdateReason	Reason for this update.
requestTime	string (date-time)	Date on which this update was requested.
requestedBy	IdentityRef	Identity which requested this update.
sourceVersion	PackageVersion	Source agent version of the update.
targetVersion	PackageVersion	Target agent version of the update.

TaskAgentUpdateReason

Object

Name	Type	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumeration

Value	Description
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

Name	Type	Description
_links	ReferenceLinks
id	integer (int32)
name	string

TaskResult

Enumeration

Result of the environment deployment execution

Value	Description
abandoned
canceled
dependentOnManualQueue
failed
manuallyQueued
skipped
succeeded
succeededWithIssues

VirtualMachineResource

Object

Name	Type	Description
agent	TaskAgent	A task agent.
createdBy	IdentityRef
createdOn	string (date-time)
environmentReference	EnvironmentReference
id	integer (int32)
lastModifiedBy	IdentityRef
lastModifiedOn	string (date-time)
name	string
tags	string[]	Tags of the Environment Resource.
type	EnvironmentResourceType	Environment resource type