Microsoft.DevCenter (stable:2025-02-01)

2025/02/20 • 117 new methods

DevCenters_ListBySubscription (new)
Description :  Lists all devcenters in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/devcenters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
DevCenters_ListByResourceGroup (new)
Description :  Lists all devcenters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
DevCenters_Get (new)
Description :  Gets a devcenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
]
,
}
,
}
DevCenters_CreateOrUpdate (new)
Description :  Creates or updates a devcenter resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
body:
{
Description: Represents a devcenter. ,
Required: True ,
}
{
properties:
{
Description: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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)

{
properties:
{
Description: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
]
,
}
,
}
DevCenters_Update (new)
Description :  Partially updates a devcenter.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
body:
{
Description: Updatable devcenter properties. ,
Required: True ,
}
{
identity:
{
Description: Managed identity properties ,
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 ,
}
,
properties:
{
Description: Properties of a Dev Center to be updated. ,
Required: False ,
}
{
encryption:
{
Description: Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations). ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
identityType:
{
Description: Values can be systemAssignedIdentity or userAssignedIdentity ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
delegatedResourceIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and delegatedResourceIdentity. ,
Format: arm-id ,
Required: False ,
}
string ,
delegatedIdentityClientId:
{
Description: delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
keyEncryptionKeyUrl:
{
Description: key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
displayName:
{
Description: The display name of the devcenter. ,
Required: False ,
}
string ,
projectCatalogSettings:
{
Description: Dev Center settings to be used when associating a project with a catalog. ,
Required: False ,
}
{
catalogItemSyncEnableStatus:
{
Description: Whether project catalogs associated with projects in this dev center can be configured to sync catalog items. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networkSettings:
{
Description: Network settings that will be enforced on network resources associated with the Dev Center. ,
Required: False ,
}
{
microsoftHostedNetworkEnableStatus:
{
Description: Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
devBoxProvisioningSettings:
{
Description: Settings to be used in the provisioning of all Dev Boxes that belong to this dev center. ,
Required: False ,
}
{
installAzureMonitorAgentEnableStatus:
{
Description: Whether project catalogs associated with projects in this dev center can be configured to sync catalog items. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DevCenter properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: 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 ,
}
,
]
,
}
,
}
DevCenters_Delete (new)
Description :  Deletes a devcenter
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ProjectPolicies_ListByDevCenter (new)
Description :  Lists all project policies in the dev center
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies
{
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 ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an project policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
ProjectPolicies_Get (new)
Description :  Gets a specific project policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies/{projectPolicyName}
{
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 ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
projectPolicyName:
{
Description: The name of the project policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an project policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ProjectPolicies_CreateOrUpdate (new)
Description :  Creates or updates an project policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies/{projectPolicyName}
{
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 ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
projectPolicyName:
{
Description: The name of the project policy. ,
Required: True ,
}
string ,
body:
{
Description: Represents an project policy. ,
Required: True ,
}
{
properties:
{
Description: Properties of an project policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an project policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of an project policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ProjectPolicies_Update (new)
Description :  Partially updates an project policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies/{projectPolicyName}
{
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 ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
projectPolicyName:
{
Description: The name of the project policy. ,
Required: True ,
}
string ,
body:
{
Description: Updatable project policy properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of an project policy to be updated. ,
Required: False ,
}
{
resourcePolicies:
{
Description: Resource policies that are a part of this project policy. ,
Required: False ,
}
[
{
resources:
{
Description: Resources that are included and shared as a part of a project policy. ,
Required: False ,
}
string ,
filter:
{
Description: Optional. When specified, this expression is used to filter the resources. ,
Required: False ,
}
string ,
action:
{
Description: Policy action to be taken on the resources. This is optional, and defaults to allow ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
resourceType:
{
Description: Optional. The resource type being restricted or allowed by a project policy. Used with a given action to restrict or allow access to a resource type. ,
Enum:
{
Images: No description available. ,
AttachedNetworks: No description available. ,
Skus: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scopes:
{
Description: Resources that have access to the shared resources that are a part of this project policy. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an project policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
ProjectPolicies_Delete (new)
Description :  Deletes an project policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies/{projectPolicyName}
{
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 ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
projectPolicyName:
{
Description: The name of the project policy. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Projects_ListBySubscription (new)
Description :  Lists all projects in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Projects_ListByResourceGroup (new)
Description :  Lists all projects in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Projects_Get (new)
Description :  Gets a specific project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
]
,
}
,
}
Projects_CreateOrUpdate (new)
Description :  Creates or updates a project.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
body:
{
Description: Represents a project. ,
Required: True ,
}
{
properties:
{
Description: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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)

{
properties:
{
Description: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
]
,
}
,
}
Projects_Update (new)
Description :  Partially updates a project.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
body:
{
Description: Updatable project properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of a project to be updated. ,
Required: False ,
}
{
devCenterId:
{
Description: Resource Id of an associated DevCenter ,
Required: False ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
maxDevBoxesPerUser:
{
Description: When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The display name of the project. ,
Required: False ,
}
string ,
catalogSettings:
{
Description: Settings to be used when associating a project with a catalog. ,
Required: False ,
}
{
catalogItemSyncTypes:
{
Description: Indicates catalog item types that can be synced. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: Managed identity properties ,
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: Properties of a project. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
devCenterUri:
{
Description: The URI of the Dev Center resource this project is associated with. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed identity properties ,
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: 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 ,
}
,
]
,
}
,
}
Projects_Delete (new)
Description :  Deletes a project resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Projects_GetInheritedSettings (new)
Description :  Gets applicable inherited settings for this project.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/getInheritedSettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
projectCatalogSettings:
{
Description: Dev Center settings to be used when associating a project with a catalog. ,
Required: False ,
}
{
catalogItemSyncEnableStatus:
{
Description: Whether project catalogs associated with projects in this dev center can be configured to sync catalog items. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networkSettings:
{
Description: Network settings that will be enforced on this project. ,
Required: False ,
}
{
microsoftHostedNetworkEnableStatus:
{
Description: Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
AttachedNetworks_ListByProject (new)
Description :  Lists the attached NetworkConnections for a Project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
AttachedNetworks_GetByProject (new)
Description :  Gets an attached NetworkConnection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks/{attachedNetworkConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
attachedNetworkConnectionName:
{
Description: The name of the attached NetworkConnection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ProjectCatalogs_List (new)
Description :  Lists the catalogs associated with a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogs_Get (new)
Description :  Gets an associated project catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogs_CreateOrUpdate (new)
Description :  Creates or updates a project catalog.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
body:
{
Description: Represents a catalog. ,
Required: True ,
}
{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogs_Patch (new)
Description :  Partially updates a project catalog.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
body:
{
Description: Updatable project catalog properties. ,
Required: True ,
}
{
properties:
{
Description: Catalog properties for update. ,
Required: False ,
}
{
gitHub:
{
Description: Properties for a GitHub catalog type. ,
Required: False ,
}
{
uri:
{
Description: Git URI. ,
Required: False ,
}
string ,
branch:
{
Description: Git branch. ,
Required: False ,
}
string ,
secretIdentifier:
{
Description: A reference to the Key Vault secret containing a security token to authenticate to a Git repository. ,
Required: False ,
}
string ,
path:
{
Description: The folder where the catalog items can be found inside the repository. ,
Required: False ,
}
string ,
}
,
adoGit:
{
Description: Properties for an Azure DevOps catalog type. ,
Required: False ,
}
{
uri:
{
Description: Git URI. ,
Required: False ,
}
string ,
branch:
{
Description: Git branch. ,
Required: False ,
}
string ,
secretIdentifier:
{
Description: A reference to the Key Vault secret containing a security token to authenticate to a Git repository. ,
Required: False ,
}
string ,
path:
{
Description: The folder where the catalog items can be found inside the repository. ,
Required: False ,
}
string ,
}
,
syncType:
{
Description: Indicates the type of sync that is configured for the catalog. ,
Enum:
{
Manual: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
ProjectCatalogs_Delete (new)
Description :  Deletes a project catalog resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
EnvironmentDefinitions_ListByProjectCatalog (new)
Description :  Lists the environment definitions in this project catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Environment definition properties. ,
Required: False ,
}
{
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter ,
Required: False ,
}
string ,
name:
{
Description: Display name of the parameter ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string) ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required ,
Required: False ,
}
boolean ,
}
,
]
,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status for the environment definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
EnvironmentDefinitions_GetByProjectCatalog (new)
Description :  Gets an environment definition from the catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}
{}

⚐ Response (200)

{
properties:
{
Description: Environment definition properties. ,
Required: False ,
}
{
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter ,
Required: False ,
}
string ,
name:
{
Description: Display name of the parameter ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string) ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required ,
Required: False ,
}
boolean ,
}
,
]
,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status for the environment definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ProjectCatalogEnvironmentDefinitions_GetErrorDetails (new)
Description :  Gets Environment Definition error details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
environmentDefinitionName:
{
Description: The name of the Environment Definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
errors:
{
Description: Errors associated with resources synchronized from the catalog. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogs_GetSyncErrorDetails (new)
Description :  Gets project catalog synchronization error details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/getSyncErrorDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
operationError:
{
Description: Error information for the overall synchronization operation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
conflicts:
{
Description: Catalog items that have conflicting names. ,
Required: False ,
}
[
{
path:
{
Description: The path of the file that has a conflicting name. ,
Required: False ,
}
string ,
name:
{
Description: Name of the conflicting catalog item. ,
Required: False ,
}
string ,
}
,
]
,
errors:
{
Description: Errors that occured during synchronization. ,
Required: False ,
}
[
{
path:
{
Description: The path of the file the error is associated with. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Errors associated with the file. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogs_Sync (new)
Description :  Syncs templates for a template source.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/sync
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
ProjectCatalogs_Connect (new)
Description :  Connects a project catalog to enable syncing.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/connect
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
Galleries_ListByDevCenter (new)
Description :  Lists galleries for a devcenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Gallery properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
galleryResourceId:
{
Description: The resource ID of the backing Azure Compute Gallery. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Galleries_Get (new)
Description :  Gets a gallery
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gallery properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
galleryResourceId:
{
Description: The resource ID of the backing Azure Compute Gallery. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Galleries_CreateOrUpdate (new)
Description :  Creates or updates a gallery.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
body:
{
Description: Represents a gallery. ,
Required: True ,
}
{
properties:
{
Description: Gallery properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
galleryResourceId:
{
Description: The resource ID of the backing Azure Compute Gallery. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gallery properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
galleryResourceId:
{
Description: The resource ID of the backing Azure Compute Gallery. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gallery properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
galleryResourceId:
{
Description: The resource ID of the backing Azure Compute Gallery. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Galleries_Delete (new)
Description :  Deletes a gallery resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Images_ListByDevCenter (new)
Description :  Lists images for a devcenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/images
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image properties. ,
Required: False ,
}
{
description:
{
Description: The description of the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the image offer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU name for the image. ,
Required: False ,
}
string ,
recommendedMachineConfiguration:
{
Description: The recommended machine configuration to use with the image. ,
Required: False ,
}
{
memory:
{
Description: Recommended memory range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vCPUs:
{
Description: Recommended vCPU range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
hibernateSupport:
{
Description: Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Images_ListByGallery (new)
Description :  Lists images for a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image properties. ,
Required: False ,
}
{
description:
{
Description: The description of the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the image offer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU name for the image. ,
Required: False ,
}
string ,
recommendedMachineConfiguration:
{
Description: The recommended machine configuration to use with the image. ,
Required: False ,
}
{
memory:
{
Description: Recommended memory range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vCPUs:
{
Description: Recommended vCPU range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
hibernateSupport:
{
Description: Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Images_Get (new)
Description :  Gets a gallery image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Image properties. ,
Required: False ,
}
{
description:
{
Description: The description of the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the image offer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU name for the image. ,
Required: False ,
}
string ,
recommendedMachineConfiguration:
{
Description: The recommended machine configuration to use with the image. ,
Required: False ,
}
{
memory:
{
Description: Recommended memory range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vCPUs:
{
Description: Recommended vCPU range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
hibernateSupport:
{
Description: Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ImageVersions_ListByImage (new)
Description :  Lists versions for an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/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. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image version properties. ,
Required: False ,
}
{
name:
{
Description: The semantic version string. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If the version should be excluded from being treated as the latest version. ,
Required: False ,
}
boolean ,
osDiskImageSizeInGb:
{
Description: The size of the OS disk image, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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_Get (new)
Description :  Gets an image version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions/{versionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the gallery. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
versionName:
{
Description: The version of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Image version properties. ,
Required: False ,
}
{
name:
{
Description: The semantic version string. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If the version should be excluded from being treated as the latest version. ,
Required: False ,
}
boolean ,
osDiskImageSizeInGb:
{
Description: The size of the OS disk image, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Images_ListByProject (new)
Description :  Lists images for a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image properties. ,
Required: False ,
}
{
description:
{
Description: The description of the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the image offer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU name for the image. ,
Required: False ,
}
string ,
recommendedMachineConfiguration:
{
Description: The recommended machine configuration to use with the image. ,
Required: False ,
}
{
memory:
{
Description: Recommended memory range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vCPUs:
{
Description: Recommended vCPU range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
hibernateSupport:
{
Description: Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Images_GetByProject (new)
Description :  Gets an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Image properties. ,
Required: False ,
}
{
description:
{
Description: The description of the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the image offer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU name for the image. ,
Required: False ,
}
string ,
recommendedMachineConfiguration:
{
Description: The recommended machine configuration to use with the image. ,
Required: False ,
}
{
memory:
{
Description: Recommended memory range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vCPUs:
{
Description: Recommended vCPU range. ,
Required: False ,
}
{
min:
{
Description: Minimum value. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
hibernateSupport:
{
Description: Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ImageVersions_ListByProject (new)
Description :  Lists versions for an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/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. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image version properties. ,
Required: False ,
}
{
name:
{
Description: The semantic version string. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If the version should be excluded from being treated as the latest version. ,
Required: False ,
}
boolean ,
osDiskImageSizeInGb:
{
Description: The size of the OS disk image, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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_GetByProject (new)
Description :  Gets an image version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions/{versionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
versionName:
{
Description: The version of the image. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Image version properties. ,
Required: False ,
}
{
name:
{
Description: The semantic version string. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The datetime that the backing image version was published. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If the version should be excluded from being treated as the latest version. ,
Required: False ,
}
boolean ,
osDiskImageSizeInGb:
{
Description: The size of the OS disk image, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Skus_ListByProject (new)
Description :  Lists SKUs available to the project
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/listSkus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
resourceType:
{
Description: The name of the resource type ,
Required: False ,
}
string ,
locations:
{
Description: SKU supported locations. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Collection of name/value pairs to describe the SKU capabilities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
AttachedNetworks_ListByDevCenter (new)
Description :  Lists the attached NetworkConnections for a DevCenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
AttachedNetworks_GetByDevCenter (new)
Description :  Gets an attached NetworkConnection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
attachedNetworkConnectionName:
{
Description: The name of the attached NetworkConnection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
AttachedNetworks_CreateOrUpdate (new)
Description :  Creates or updates an attached NetworkConnection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
attachedNetworkConnectionName:
{
Description: The name of the attached NetworkConnection. ,
Required: True ,
}
string ,
body:
{
Description: Represents an attached NetworkConnection. ,
Required: True ,
}
{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Attached NetworkConnection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
networkConnectionId:
{
Description: The resource ID of the NetworkConnection you want to attach. ,
Required: True ,
}
string ,
networkConnectionLocation:
{
Description: The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives. ,
Required: False ,
}
string ,
healthCheckStatus:
{
Description: Health check status values ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
domainJoinType:
{
Description: AAD Join type of the network. This is populated based on the referenced Network Connection. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
AttachedNetworks_Delete (new)
Description :  Un-attach a NetworkConnection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
attachedNetworkConnectionName:
{
Description: The name of the attached NetworkConnection. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Catalogs_ListByDevCenter (new)
Description :  Lists catalogs for a devcenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Catalogs_Get (new)
Description :  Gets a catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
Catalogs_CreateOrUpdate (new)
Description :  Creates or updates a catalog.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
body:
{
Description: Represents a catalog. ,
Required: True ,
}
{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
Catalogs_Update (new)
Description :  Partially updates a catalog.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
body:
{
Description: Updatable catalog properties. ,
Required: True ,
}
{
properties:
{
Description: Catalog properties for update. ,
Required: False ,
}
{
gitHub:
{
Description: Properties for a GitHub catalog type. ,
Required: False ,
}
{
uri:
{
Description: Git URI. ,
Required: False ,
}
string ,
branch:
{
Description: Git branch. ,
Required: False ,
}
string ,
secretIdentifier:
{
Description: A reference to the Key Vault secret containing a security token to authenticate to a Git repository. ,
Required: False ,
}
string ,
path:
{
Description: The folder where the catalog items can be found inside the repository. ,
Required: False ,
}
string ,
}
,
adoGit:
{
Description: Properties for an Azure DevOps catalog type. ,
Required: False ,
}
{
uri:
{
Description: Git URI. ,
Required: False ,
}
string ,
branch:
{
Description: Git branch. ,
Required: False ,
}
string ,
secretIdentifier:
{
Description: A reference to the Key Vault secret containing a security token to authenticate to a Git repository. ,
Required: False ,
}
string ,
path:
{
Description: The folder where the catalog items can be found inside the repository. ,
Required: False ,
}
string ,
}
,
syncType:
{
Description: Indicates the type of sync that is configured for the catalog. ,
Enum:
{
Manual: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Catalog properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: The synchronization state of the catalog. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncStats:
{
Description: Stats of the latest synchronization. ,
Required: False ,
}
{
added:
{
Description: Count of catalog items added during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
updated:
{
Description: Count of catalog items updated during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
unchanged:
{
Description: Count of catalog items that were unchanged during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
removed:
{
Description: Count of catalog items removed during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
validationErrors:
{
Description: Count of catalog items that had validation errors during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
synchronizationErrors:
{
Description: Count of synchronization errors that occured during synchronization. ,
Format: int32 ,
Required: False ,
}
integer ,
syncedCatalogItemTypes:
{
Description: Indicates catalog item types that were synced. ,
Required: False ,
}
[
string ,
]
,
}
,
connectionState:
{
Description: The connection state of the catalog. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
lastConnectionTime:
{
Description: When the catalog was last connected. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: When the catalog was last synced. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
Catalogs_Delete (new)
Description :  Deletes a catalog resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Catalogs_GetSyncErrorDetails (new)
Description :  Gets catalog synchronization error details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/getSyncErrorDetails
{}

⚐ Response (200)

{
operationError:
{
Description: Error information for the overall synchronization operation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
conflicts:
{
Description: Catalog items that have conflicting names. ,
Required: False ,
}
[
{
path:
{
Description: The path of the file that has a conflicting name. ,
Required: False ,
}
string ,
name:
{
Description: Name of the conflicting catalog item. ,
Required: False ,
}
string ,
}
,
]
,
errors:
{
Description: Errors that occured during synchronization. ,
Required: False ,
}
[
{
path:
{
Description: The path of the file the error is associated with. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Errors associated with the file. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
Catalogs_Sync (new)
Description :  Syncs templates for a template source.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/sync
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
Catalogs_Connect (new)
Description :  Connects a catalog to enable syncing.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/connect
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
EnvironmentTypes_ListByDevCenter (new)
Description :  Lists environment types for the devcenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
EnvironmentTypes_Get (new)
Description :  Gets an environment type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
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 ,
}
,
]
,
}
,
}
EnvironmentTypes_CreateOrUpdate (new)
Description :  Creates or updates an environment type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
body:
{
Description: Represents an Environment Type. ,
Required: True ,
}
{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
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 ,
}
,
]
,
}
,
}
EnvironmentTypes_Update (new)
Description :  Partially updates an environment type.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
body:
{
Description: Updatable environment type properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of an environment type to be updated. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the environment type. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
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 ,
}
,
]
,
}
,
}
EnvironmentTypes_Delete (new)
Description :  Deletes an environment type.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ProjectAllowedEnvironmentTypes_List (new)
Description :  Lists allowed environment types for a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an allowed environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the allowed environment type. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
ProjectAllowedEnvironmentTypes_Get (new)
Description :  Gets an allowed environment type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an allowed environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the allowed environment type. ,
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 ,
}
,
]
,
}
,
}
ProjectEnvironmentTypes_List (new)
Description :  Lists environment types for a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
environmentCount:
{
Description: The number of environments of this type. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
location:
{
Description: The geo-location for the environment type ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
ProjectEnvironmentTypes_Get (new)
Description :  Gets a project environment type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
environmentCount:
{
Description: The number of environments of this type. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
location:
{
Description: The geo-location for the environment type ,
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 ,
}
,
]
,
}
,
}
ProjectEnvironmentTypes_CreateOrUpdate (new)
Description :  Creates or updates a project environment type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
body:
{
Description: Represents a Project Environment Type. ,
Required: True ,
}
{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
environmentCount:
{
Description: The number of environments of this type. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
location:
{
Description: The geo-location for the environment type ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
environmentCount:
{
Description: The number of environments of this type. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
location:
{
Description: The geo-location for the environment type ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
environmentCount:
{
Description: The number of environments of this type. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
location:
{
Description: The geo-location for the environment type ,
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 ,
}
,
]
,
}
,
}
ProjectEnvironmentTypes_Update (new)
Description :  Partially updates a project environment type.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
body:
{
Description: Updatable project environment type properties. ,
Required: True ,
}
{
properties:
{
Description: Properties to configure an environment type. ,
Required: False ,
}
{
deploymentTargetId:
{
Description: Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the project environment type. ,
Required: False ,
}
string ,
status:
{
Description: Defines whether this Environment Type can be used in this Project. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creatorRoleAssignment:
{
Description: The role definition assigned to the environment creator on backing resources. ,
Required: False ,
}
{
roles:
{
Description: A map of roles to assign to the environment creator. ,
Required: False ,
}
object ,
}
,
userRoleAssignments:
{
Description: Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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: Properties of an environment type. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
environmentCount:
{
Description: The number of environments of this type. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identity properties ,
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 ,
}
,
location:
{
Description: The geo-location for the environment type ,
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 ,
}
,
]
,
}
,
}
ProjectEnvironmentTypes_Delete (new)
Description :  Deletes a project environment type.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
environmentTypeName:
{
Description: The name of the environment type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_ListByDevCenter (new)
Description :  List Dev Box definitions for a devcenter.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_Get (new)
Description :  Gets a Dev Box definition
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}
{}

⚐ Response (200)

{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_CreateOrUpdate (new)
Description :  Creates or updates a Dev Box definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}
{
body:
{
Description: Represents a Dev Box definition. ,
Required: True ,
}
{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_Update (new)
Description :  Partially updates a Dev Box definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}
{
body:
{
Description: Represents a Dev Box definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of a Dev Box definition to be updated. ,
Required: False ,
}
{
imageReference:
{
Description: Image reference information. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU for Dev Boxes created using this definition. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osStorageType:
{
Description: The storage type used for the Operating System disk of Dev Boxes created using this definition. ,
Required: False ,
}
string ,
hibernateSupport:
{
Description: Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_Delete (new)
Description :  Deletes a Dev Box definition
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}
{}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_ListByProject (new)
Description :  List Dev Box definitions configured for a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
DevBoxDefinitions_GetByProject (new)
Description :  Gets a Dev Box definition configured for a project
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions/{devBoxDefinitionName}
{}

⚐ Response (200)

{
properties:
{
Description: Dev Box definition properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Dev Box Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available resource provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevCenter/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). ,
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 ,
}
,
]
,
}
,
}
OperationStatuses_Get (new)
Description :  Gets the current status of an async operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/operationStatuses/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The Azure region ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: The current status of an async operation ,
}
{
properties:
{
Description: Custom operation properties, populated only for a successful operation. ,
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 ,
}
,
]
,
}
,
}
Usages_ListByLocation (new)
Description :  Lists the current usages and limits in this location for the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/usages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The Azure region ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array page of Usages. ,
Required: False ,
}
[
{
currentValue:
{
Description: The current usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The limit integer. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: The unit details. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name. ,
Required: False ,
}
{
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The fully qualified arm resource id. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to get the next page of Usage result. ,
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Execute (new)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if resource name is available. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
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 ,
}
,
]
,
}
,
}
CheckScopedNameAvailability_Execute (new)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkScopedNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if resource name is available. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
scope:
{
Description: The resource id to scope the name check. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
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 ,
}
,
]
,
}
,
}
CustomizationTasks_ListByCatalog (new)
Description :  List Tasks in the catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Task properties ,
Required: False ,
}
{
inputs:
{
Description: Inputs to the task. ,
Required: False ,
}
object ,
timeout:
{
Description: The default timeout for the task. ,
Format: int32 ,
Required: False ,
}
integer ,
validationStatus:
{
Description: Validation status for the Task. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
CustomizationTasks_Get (new)
Description :  Gets a Task from the catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}
{}

⚐ Response (200)

{
properties:
{
Description: Task properties ,
Required: False ,
}
{
inputs:
{
Description: Inputs to the task. ,
Required: False ,
}
object ,
timeout:
{
Description: The default timeout for the task. ,
Format: int32 ,
Required: False ,
}
integer ,
validationStatus:
{
Description: Validation status for the Task. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
CustomizationTasks_GetErrorDetails (new)
Description :  Gets Customization Task error details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}/getErrorDetails
{}

⚐ Response (200)

{
errors:
{
Description: Errors associated with resources synchronized from the catalog. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
EnvironmentDefinitions_ListByCatalog (new)
Description :  List environment definitions in the catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
devCenterName:
{
Description: The name of the devcenter. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10'. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Environment definition properties. ,
Required: False ,
}
{
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter ,
Required: False ,
}
string ,
name:
{
Description: Display name of the parameter ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string) ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required ,
Required: False ,
}
boolean ,
}
,
]
,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status for the environment definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
EnvironmentDefinitions_Get (new)
Description :  Gets an environment definition from the catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}
{}

⚐ Response (200)

{
properties:
{
Description: Environment definition properties. ,
Required: False ,
}
{
description:
{
Description: A short description of the environment definition. ,
Required: False ,
}
string ,
parameters:
{
Description: Input parameters passed to an environment. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID of the parameter ,
Required: False ,
}
string ,
name:
{
Description: Display name of the parameter ,
Required: False ,
}
string ,
description:
{
Description: Description of the parameter ,
Required: False ,
}
string ,
type:
{
Description: A string of one of the basic JSON types (number, integer, array, object, boolean, string) ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
readOnly:
{
Description: Whether or not this parameter is read-only. If true, default should have a value. ,
Required: False ,
}
boolean ,
required:
{
Description: Whether or not this parameter is required ,
Required: False ,
}
boolean ,
}
,
]
,
templatePath:
{
Description: Path to the Environment Definition entrypoint file. ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status for the environment definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
EnvironmentDefinitions_GetErrorDetails (new)
Description :  Gets Environment Definition error details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails
{}

⚐ Response (200)

{
errors:
{
Description: Errors associated with resources synchronized from the catalog. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitions_ListByProjectCatalog (new)
Description :  List Image Definitions in the catalog.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image Definition properties ,
Required: False ,
}
{
imageReference:
{
Description: Image reference information. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
fileUrl:
{
Description: The URL to the repository file containing the image definition. ,
Required: False ,
}
string ,
latestBuild:
{
Description: Details about the latest build. ,
Required: False ,
}
{
name:
{
Description: Identifier of a build. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The state of an Image Definition Build. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
}
,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Image Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
autoImageBuild:
{
Description: Indicates if automatic image builds will be triggered for image definition updates ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitions_GetByProjectCatalog (new)
Description :  Gets an Image Definition from the catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}
{}

⚐ Response (200)

{
properties:
{
Description: Image Definition properties ,
Required: False ,
}
{
imageReference:
{
Description: Image reference information. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
fileUrl:
{
Description: The URL to the repository file containing the image definition. ,
Required: False ,
}
string ,
latestBuild:
{
Description: Details about the latest build. ,
Required: False ,
}
{
name:
{
Description: Identifier of a build. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The state of an Image Definition Build. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
}
,
imageValidationStatus:
{
Description: Validation status of the configured image. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
imageValidationErrorDetails:
{
Description: Details for image validator error. Populated when the image validation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
validationStatus:
{
Description: Validation status for the Image Definition. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
autoImageBuild:
{
Description: Indicates if automatic image builds will be triggered for image definition updates ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitions_GetErrorDetails (new)
Description :  Gets Image Definition error details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/getErrorDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
imageDefinitionName:
{
Description: The name of the Image Definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
errors:
{
Description: Errors associated with resources synchronized from the catalog. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitions_BuildImage (new)
Description :  Builds an image for the specified Image Definition.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/buildImage
{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: 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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitionBuilds_ListByImageDefinition (new)
Description :  Lists builds for a specified image definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Image Definition Build properties ,
Required: False ,
}
{
imageReference:
{
Description: The specific image version used by the build. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the build. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details for image creation error. Populated when the image creation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitionBuild_Get (new)
Description :  Gets a build for a specified image definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}
{}

⚐ Response (200)

{
properties:
{
Description: Image Definition Build properties ,
Required: False ,
}
{
imageReference:
{
Description: The specific image version used by the build. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the build. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details for image creation error. Populated when the image creation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitionBuild_Cancel (new)
Description :  Cancels the specified build for an image definition.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}/cancel
{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: 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 ,
}
,
]
,
}
,
}
ProjectCatalogImageDefinitionBuild_GetBuildDetails (new)
Description :  Gets Build details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}/getBuildDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
catalogName:
{
Description: The name of the Catalog. ,
Required: True ,
}
string ,
imageDefinitionName:
{
Description: The name of the Image Definition. ,
Required: True ,
}
string ,
buildName:
{
Description: The ID of the Image Definition Build. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageReference:
{
Description: The specific image version used by the build. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the build. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details for image creation error. Populated when the image creation is not successful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error. ,
Required: False ,
}
string ,
}
,
taskGroups:
{
Description: The list of task groups executed during the image definition build. ,
Required: False ,
}
[
{
name:
{
Description: The name of the task group. ,
Required: False ,
}
string ,
status:
{
Description: The status of the task group. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task group. ,
Format: date-time ,
Required: False ,
}
string ,
tasks:
{
Description: The list of tasks executed during the task group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the task. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the task. ,
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
displayName:
{
Description: Display name to help differentiate multiple instances of the same task. ,
Required: False ,
}
string ,
id:
{
Description: ID of the task instance. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the task. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the task. ,
Enum:
{
Succeeded: The image build has succeeded. ,
Running: The image build is running. ,
ValidationFailed: The built image has failed validation. ,
Failed: The image build has failed. ,
Cancelled: The image build has been cancelled. ,
TimedOut: The image build has timed out. ,
}
,
Required: False ,
}
enum ,
logUri:
{
Description: The URI for retrieving logs for the task execution. ,
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 ,
}
,
]
,
}
,
}
Skus_ListBySubscription (new)
Description :  Lists the Microsoft.DevCenter SKUs available in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/skus
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
resourceType:
{
Description: The name of the resource type ,
Required: False ,
}
string ,
locations:
{
Description: SKU supported locations. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Collection of name/value pairs to describe the SKU capabilities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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_ListByProject (new)
Description :  Lists pools for a project
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Pool properties ,
Required: False ,
}
{
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Healthy: No description available. ,
Warning: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
healthStatusDetails:
{
Description: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the issue. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the issue, intended to be suitable for display in a user interface ,
Required: False ,
}
string ,
}
,
]
,
devBoxCount:
{
Description: Indicates the number of provisioned Dev Boxes in this pool. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 :  Gets a machine pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
{}

⚐ Response (200)

{
properties:
{
Description: Pool properties ,
Required: False ,
}
{
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Healthy: No description available. ,
Warning: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
healthStatusDetails:
{
Description: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the issue. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the issue, intended to be suitable for display in a user interface ,
Required: False ,
}
string ,
}
,
]
,
devBoxCount:
{
Description: Indicates the number of provisioned Dev Boxes in this pool. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Pools_CreateOrUpdate (new)
Description :  Creates or updates a machine pool
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
{
body:
{
Description: Represents a machine pool ,
Required: True ,
}
{
properties:
{
Description: Pool properties ,
Required: False ,
}
{
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Healthy: No description available. ,
Warning: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
healthStatusDetails:
{
Description: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the issue. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the issue, intended to be suitable for display in a user interface ,
Required: False ,
}
string ,
}
,
]
,
devBoxCount:
{
Description: Indicates the number of provisioned Dev Boxes in this pool. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Pool properties ,
Required: False ,
}
{
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Healthy: No description available. ,
Warning: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
healthStatusDetails:
{
Description: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the issue. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the issue, intended to be suitable for display in a user interface ,
Required: False ,
}
string ,
}
,
]
,
devBoxCount:
{
Description: Indicates the number of provisioned Dev Boxes in this pool. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Pool properties ,
Required: False ,
}
{
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Healthy: No description available. ,
Warning: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
healthStatusDetails:
{
Description: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the issue. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the issue, intended to be suitable for display in a user interface ,
Required: False ,
}
string ,
}
,
]
,
devBoxCount:
{
Description: Indicates the number of provisioned Dev Boxes in this pool. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Pools_Update (new)
Description :  Partially updates a machine pool
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
{
body:
{
Description: Represents a machine pool ,
Required: True ,
}
{
properties:
{
Description: Properties of a pool to be updated. ,
Required: False ,
}
{
devBoxDefinitionType:
{
Description: Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly. ,
Enum:
{
Reference: No description available. ,
Value: No description available. ,
}
,
Required: False ,
}
enum ,
devBoxDefinitionName:
{
Description: Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value. ,
Required: False ,
}
string ,
devBoxDefinition:
{
Description: A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided. ,
Required: False ,
}
{
imageReference:
{
Description: Image reference information. ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU for Dev Boxes created from the Pool. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
activeImageReference:
{
Description: Image reference information for the currently active image (only populated during updates). ,
Required: False ,
}
{
id:
{
Description: Image ID, or Image version ID. When Image ID is provided, its latest version will be used. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. ,
Required: False ,
}
string ,
}
,
}
,
networkConnectionName:
{
Description: Name of a Network Connection in parent Project of this Pool ,
Required: False ,
}
string ,
licenseType:
{
Description: Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. ,
Enum:
{
Windows_Client: No description available. ,
}
,
Required: False ,
}
enum ,
localAdministrator:
{
Description: Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
stopOnDisconnect:
{
Description: Stop on disconnect configuration settings for Dev Boxes created in this pool. ,
Required: False ,
}
{
status:
{
Description: Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
gracePeriodMinutes:
{
Description: The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
stopOnNoConnect:
{
Description: Stop on no connect configuration settings for Dev Boxes created in this pool. ,
Required: False ,
}
{
status:
{
Description: Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
gracePeriodMinutes:
{
Description: The specified time in minutes to wait before stopping a Dev Box if no connection is made. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
singleSignOnStatus:
{
Description: Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the pool. ,
Required: False ,
}
string ,
virtualNetworkType:
{
Description: Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. ,
Enum:
{
Managed: No description available. ,
Unmanaged: No description available. ,
}
,
Required: False ,
}
enum ,
managedVirtualNetworkRegions:
{
Description: The regions of the managed virtual network (required when managedNetworkType is Managed). ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Pool properties ,
Required: False ,
}
{
healthStatus:
{
Description: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Healthy: No description available. ,
Warning: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
healthStatusDetails:
{
Description: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the issue. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the issue, intended to be suitable for display in a user interface ,
Required: False ,
}
string ,
}
,
]
,
devBoxCount:
{
Description: Indicates the number of provisioned Dev Boxes in this pool. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: 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_Delete (new)
Description :  Deletes a machine pool
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
{}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Pools_RunHealthChecks (new)
Description :  Triggers a refresh of the pool status.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/runHealthChecks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project. ,
Required: True ,
}
string ,
poolName:
{
Description: Name of the pool. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
Schedules_ListByPool (new)
Description :  Lists schedules for a pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a Schedule resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
Schedules_Get (new)
Description :  Gets a schedule resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}
{}

⚐ Response (200)

{
properties:
{
Description: Properties of a Schedule resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Schedules_CreateOrUpdate (new)
Description :  Creates or updates a Schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}
{
body:
{
Description: Represents a scheduled task ,
Required: True ,
}
{
properties:
{
Description: Properties of a Schedule resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Schedule resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a Schedule resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Schedules_Update (new)
Description :  Partially updates a Scheduled.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}
{
body:
{
Description: Represents a scheduled task. ,
Required: True ,
}
{
properties:
{
Description: Properties of a schedule resource to be updated. ,
Required: False ,
}
{
type:
{
Description: Supported type this scheduled task represents. ,
Enum:
{
StopDevBox: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: The frequency of this scheduled task. ,
Enum:
{
Daily: No description available. ,
}
,
Required: False ,
}
enum ,
time:
{
Description: The target time to trigger the action. The format is HH:MM. ,
Required: False ,
}
string ,
timeZone:
{
Description: The IANA timezone id at which the schedule should execute. ,
Required: False ,
}
string ,
state:
{
Description: Indicates whether or not this scheduled task is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Schedule resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
Schedules_Delete (new)
Description :  Deletes a Scheduled.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}
{}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
NetworkConnections_ListBySubscription (new)
Description :  Lists network connections in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/networkConnections
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
NetworkConnections_ListByResourceGroup (new)
Description :  Lists network connections in a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
NetworkConnections_Get (new)
Description :  Gets a network connection resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}
{}

⚐ Response (200)

{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
NetworkConnections_CreateOrUpdate (new)
Description :  Creates or updates a Network Connections resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}
{
body:
{
Description: Represents network connection ,
Required: True ,
}
{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
NetworkConnections_Update (new)
Description :  Partially updates a Network Connection
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}
{
body:
{
Description: Represents network connection ,
Required: True ,
}
{
properties:
{
Description: Properties of a network connection resource to be updated. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet to attach Virtual Machines to ,
Required: False ,
}
string ,
domainName:
{
Description: Active Directory domain name ,
Required: False ,
}
string ,
organizationUnit:
{
Description: Active Directory domain Organization Unit (OU) ,
Required: False ,
}
string ,
domainUsername:
{
Description: The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com. ,
Required: False ,
}
string ,
domainPassword:
{
Description: The password for the account used to join domain ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Network Connection ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Updated: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
StorageProvisioningFailed: No description available. ,
}
,
Required: False ,
}
enum ,
healthCheckStatus:
{
Description: Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
networkingResourceGroupName:
{
Description: The name for resource group where NICs will be placed. ,
Required: False ,
}
string ,
domainJoinType:
{
Description: AAD Join type. ,
Enum:
{
HybridAzureADJoin: No description available. ,
AzureADJoin: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
NetworkConnections_Delete (new)
Description :  Deletes a Network Connections resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}
{}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
NetworkConnections_ListHealthDetails (new)
Description :  Lists health check status details
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks
{}

⚐ Response (200)

{
value:
{
Description: Current page of results. ,
Required: False ,
}
[
{
properties:
{
Description: Health check status details properties. ,
Required: False ,
}
{
startDateTime:
{
Description: Start time of last execution of the health checks. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: End time of last execution of the health checks. ,
Format: date-time ,
Required: False ,
}
string ,
healthChecks:
{
Description: Details for each health check item. ,
Required: False ,
}
[
{
status:
{
Description: The status of the health check item. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of this health check item. ,
Required: False ,
}
string ,
startDateTime:
{
Description: Start time of health check item. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: End time of the health check item. ,
Format: date-time ,
Required: False ,
}
string ,
errorType:
{
Description: The type of error that occurred during this health check. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to fix the corresponding error. ,
Required: False ,
}
string ,
additionalDetails:
{
Description: Additional details about the health check or the recommended action. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results if there are any. ,
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 ,
}
,
]
,
}
,
}
NetworkConnections_GetHealthDetails (new)
Description :  Gets health check status details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks/latest
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkConnectionName:
{
Description: Name of the Network Connection that can be applied to a Pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Health check status details properties. ,
Required: False ,
}
{
startDateTime:
{
Description: Start time of last execution of the health checks. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: End time of last execution of the health checks. ,
Format: date-time ,
Required: False ,
}
string ,
healthChecks:
{
Description: Details for each health check item. ,
Required: False ,
}
[
{
status:
{
Description: The status of the health check item. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Passed: No description available. ,
Warning: No description available. ,
Failed: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of this health check item. ,
Required: False ,
}
string ,
startDateTime:
{
Description: Start time of health check item. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: End time of the health check item. ,
Format: date-time ,
Required: False ,
}
string ,
errorType:
{
Description: The type of error that occurred during this health check. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to fix the corresponding error. ,
Required: False ,
}
string ,
additionalDetails:
{
Description: Additional details about the health check or the recommended action. ,
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 ,
}
,
]
,
}
,
}
NetworkConnections_RunHealthChecks (new)
Description :  Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/runHealthChecks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkConnectionName:
{
Description: Name of the Network Connection that can be applied to a Pool. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
NetworkConnections_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/outboundNetworkDependenciesEndpoints
{}

⚐ Response (200)

{
value:
{
Description: The collection of outbound network dependency endpoints returned by the listing operation. ,
Required: False ,
}
[
{
category:
{
Description: The type of service that the agent connects to. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints for this service for which the agent requires outbound access. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable supplemental information about the dependency and when it is applicable. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The list of connection details for this endpoint. ,
Required: False ,
}
[
{
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
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 ,
}
,
]
,
}
,
}