Microsoft.DevOpsInfrastructure (stable:2025-01-21)

2025/01/27 • 12 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevOpsInfrastructure/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_CheckNameAvailability (new)
Description :  Checks that the pool name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: The CheckAvailability request ,
Required: True ,
}
{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource that is used as the scope of the availability check. ,
Enum:
{
Microsoft.DevOpsInfrastructure/pools: DevOpsInfrastructure pool resource. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
available:
{
Description: Availability status of the name. ,
Enum:
{
Available: The name is available. ,
Unavailable: The name is unavailable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A message explaining why the name is unavailable. Will be null if the name is available. ,
Required: True ,
}
string ,
name:
{
Description: The name whose availability was checked. ,
Required: True ,
}
string ,
reason:
{
Description: The reason code explaining why the name is unavailable. Will be null if the name is available. ,
Enum:
{
Invalid: The name is invalid. ,
AlreadyExists: The name already exists. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sku_ListByLocation (new)
Description :  List ResourceSku resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{locationName}/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: Name of the location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceSku items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of virtual machines in a scale set ,
Required: True ,
}
string ,
size:
{
Description: The size of the SKU. ,
Required: True ,
}
string ,
family:
{
Description: The family of the SKU. ,
Required: True ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available. ,
Required: True ,
}
[
string ,
]
,
locationInfo:
{
Description: A list of locations and availability zones in those locations where the SKU is available ,
Required: True ,
}
[
{
location:
{
Description: Location of the SKU ,
Required: True ,
}
string ,
zones:
{
Description: List of availability zones where the SKU is supported. ,
Required: True ,
}
[
string ,
]
,
zoneDetails:
{
Description: Gets details of capabilities available to a SKU in specific zones. ,
Required: True ,
}
[
{
name:
{
Description: Gets the set of zones that the SKU is available in with the specified capabilities. ,
Required: True ,
}
[
string ,
]
,
capabilities:
{
Description: A list of capabilities that are available for the SKU in the specified list of zones. ,
Required: True ,
}
[
{
name:
{
Description: The name of the SKU capability. ,
Required: True ,
}
string ,
value:
{
Description: The value of the SKU capability. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
capabilities:
{
Description: Name value pairs to describe the capability. ,
Required: True ,
}
[
{
name:
{
Description: The name of the SKU capability. ,
Required: True ,
}
string ,
value:
{
Description: The value of the SKU capability. ,
Required: True ,
}
string ,
}
,
]
,
restrictions:
{
Description: The restrictions of the SKU. ,
Required: True ,
}
[
{
type:
{
Description: the type of restrictions. ,
Enum:
{
Location: SKU restricted by location. ,
Zone: SKU restricted by availability zone. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: True ,
}
[
string ,
]
,
restrictionInfo:
{
Description: The information about the restriction where the SKU cannot be used. ,
Required: True ,
}
{
locations:
{
Description: Locations where the SKU is restricted ,
Required: False ,
}
[
string ,
]
,
zones:
{
Description: List of availability zones where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
reasonCode:
{
Description: the reason for restriction. ,
Enum:
{
QuotaId: The restriction is due to exceeding a quota limitation. ,
NotAvailableForSubscription: The restriction is not available for this subscription. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SubscriptionUsages_Usages (new)
Description :  List Quota resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{location}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Quota items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of the quota. ,
Required: False ,
}
{
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Fully qualified ARM resource id ,
Format: arm-id ,
Required: True ,
}
string ,
unit:
{
Description: The unit of usage measurement. ,
Required: True ,
}
string ,
currentValue:
{
Description: The current usage of the resource. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_ListBySubscription (new)
Description :  List Pool resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/pools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImageVersions_ListByImage (new)
Description :  List ImageVersion resources by Image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/images/{imageName}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
imageName:
{
Description: Name of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImageVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: Version of the image. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_ListByResourceGroup (new)
Description :  List Pool resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_Get (new)
Description :  Get a Pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Name of the pool. It needs to be globally unique. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_CreateOrUpdate (new)
Description :  Create a Pool
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Name of the pool. It needs to be globally unique. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete tracked resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_Update (new)
Description :  Update a Pool
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Name of the pool. It needs to be globally unique. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: False ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: False ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: False ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: False ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the current operation. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
maximumConcurrency:
{
Description: Defines how many resources can there be created at any given time. ,
Format: int32 ,
Required: True ,
}
integer ,
organizationProfile:
{
Description: Defines the organization in which the pool will be used. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for OrganizationProfile. ,
Required: True ,
}
string ,
}
,
agentProfile:
{
Description: Defines how the machine will be handled once it executed a job. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for AgentProfile. ,
Required: True ,
}
string ,
resourcePredictions:
{
Description: Defines pool buffer/stand-by agents. ,
Required: False ,
}
object ,
resourcePredictionsProfile:
{
Description: Defines how the pool buffer/stand-by agents is provided. ,
Required: False ,
}
{
kind:
{
Description: Determines how the stand-by scheme should be provided. ,
Enum:
{
Manual: Customer provides the stand-by agent scheme. ,
Automatic: The stand-by agent scheme is determined based on historical demand. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
fabricProfile:
{
Description: Defines the type of fabric the agent will run on. ,
Required: True ,
}
{
kind:
{
Description: Discriminator property for FabricProfile. ,
Required: True ,
}
string ,
}
,
devCenterProjectResourceId:
{
Description: The resource id of the DevCenter Project the pool belongs to. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_Delete (new)
Description :  Delete a Pool
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Name of the pool. It needs to be globally unique. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceDetails_ListByPool (new)
Description :  List ResourceDetailsObject resources by Pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}/resources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Name of the pool. It needs to be globally unique. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceDetailsObject items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: The status of the resource. ,
Enum:
{
Ready: Represents a machine resource that is ready. ,
NotReady: Represents a machine resource that is not ready. ,
Allocated: Represents a machine resource that is allocated. ,
PendingReturn: Represents a machine resource that is pending return. ,
Returned: Represents a machine resource that is returned. ,
Leased: Represents a machine resource that is leased. ,
Provisioning: Represents a machine resource that is provisioning. ,
Updating: Represents a machine resource that is updating. ,
Starting: Represents a machine resource that is starting. ,
PendingReimage: Represents a machine resource that is pending reimage. ,
Reimaging: Represents a machine resource that is reimaging. ,
}
,
Required: True ,
}
enum ,
image:
{
Description: The image name of the resource. ,
Required: True ,
}
string ,
imageVersion:
{
Description: The version of the image running on the resource. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}