Microsoft.DevSpaces (stable:2019-04-01)

2025/10/23 • 9 new, 9 deleted methods

ContainerHostMappings_GetContainerHostMapping (new)
Description :  Returns container host mapping object for a container host resource ID if an associated controller exists.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/locations/{location}/checkContainerHostMapping
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
containerHostMapping:
{
Required: True ,
}
{
containerHostResourceId:
{
Description: ARM ID of the Container Host resource ,
Required: False ,
}
string ,
mappedControllerResourceId:
{
Description: ARM ID of the mapped Controller resource ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
location:
{
Description: Location of the container host. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
containerHostResourceId:
{
Description: ARM ID of the Container Host resource ,
Required: False ,
}
string ,
mappedControllerResourceId:
{
Description: ARM ID of the mapped Controller resource ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all the supported operations by the Microsoft.DevSpaces resource provider along with their description.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevSpaces/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Resource provider operations list. ,
Required: False ,
}
[
{
name:
{
Description: Resource provider operation name. ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Description: Name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the resource provider operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource provider operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure operations. ,
Required: False ,
}
string ,
}
Controllers_Get (new)
Description :  Gets the properties for an Azure Dev Spaces Controller.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_Create (new)
Description :  Creates an Azure Dev Spaces Controller with the specified create parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
controller:
{
Description: Controller create parameters. ,
Required: True ,
}
{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_Delete (new)
Description :  Deletes an existing Azure Dev Spaces Controller.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_Update (new)
Description :  Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
controllerUpdateParameters:
{
Description: Parameters for updating the Azure Dev Spaces Controller. ,
Required: True ,
}
{
tags:
{
Description: Tags for the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_ListByResourceGroup (new)
Description :  Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Dev Spaces Controllers. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure Dev Spaces Controllers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_List (new)
Description :  Lists all the Azure Dev Spaces Controllers with their properties in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevSpaces/controllers
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Dev Spaces Controllers. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure Dev Spaces Controllers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_ListConnectionDetails (new)
Description :  Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}/listConnectionDetails
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
listConnectionDetailsParameters:
{
Description: Parameters for listing connection details of Azure Dev Spaces Controller. ,
Required: True ,
}
{
targetContainerHostResourceId:
{
Description: Resource ID of the target container host mapped to the Azure Dev Spaces Controller. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
connectionDetailsList:
{
Description: List of Azure Dev Spaces Controller connection details. ,
Required: False ,
}
[
{
orchestratorSpecificConnectionDetails:
{
Description: Base class for types that supply values used to connect to container orchestrators ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
ContainerHostMappings_GetContainerHostMapping (removed)
Description :  Returns container host mapping object for a container host resource ID if an associated controller exists.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/locations/{location}/checkContainerHostMapping
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
containerHostMapping:
{
Required: True ,
}
{
containerHostResourceId:
{
Description: ARM ID of the Container Host resource ,
Required: False ,
}
string ,
mappedControllerResourceId:
{
Description: ARM ID of the mapped Controller resource ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
location:
{
Description: Location of the container host. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
containerHostResourceId:
{
Description: ARM ID of the Container Host resource ,
Required: False ,
}
string ,
mappedControllerResourceId:
{
Description: ARM ID of the mapped Controller resource ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all the supported operations by the Microsoft.DevSpaces resource provider along with their description.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevSpaces/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Resource provider operations list. ,
Required: False ,
}
[
{
name:
{
Description: Resource provider operation name. ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Description: Name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the resource provider operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource provider operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure operations. ,
Required: False ,
}
string ,
}
Controllers_Get (removed)
Description :  Gets the properties for an Azure Dev Spaces Controller.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_Create (removed)
Description :  Creates an Azure Dev Spaces Controller with the specified create parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
controller:
{
Description: Controller create parameters. ,
Required: True ,
}
{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_Delete (removed)
Description :  Deletes an existing Azure Dev Spaces Controller.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_Update (removed)
Description :  Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
controllerUpdateParameters:
{
Description: Parameters for updating the Azure Dev Spaces Controller. ,
Required: True ,
}
{
tags:
{
Description: Tags for the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_ListByResourceGroup (removed)
Description :  Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Dev Spaces Controllers. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure Dev Spaces Controllers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_List (removed)
Description :  Lists all the Azure Dev Spaces Controllers with their properties in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevSpaces/controllers
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Dev Spaces Controllers. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the Azure Dev Spaces Controller. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
hostSuffix:
{
Description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller. ,
Required: False ,
}
string ,
dataPlaneFqdn:
{
Description: DNS name for accessing DataPlane services ,
Required: False ,
}
string ,
targetContainerHostApiServerFqdn:
{
Description: DNS of the target container host's API server ,
Required: False ,
}
string ,
targetContainerHostResourceId:
{
Description: Resource ID of the target container host ,
Required: True ,
}
string ,
targetContainerHostCredentialsBase64:
{
Description: Credentials of the target container host (base64). ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Model representing SKU for Azure Dev Spaces Controller. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of the SKU for Azure Dev Spaces Controller. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure Dev Spaces Controllers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Controllers_ListConnectionDetails (removed)
Description :  Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}/listConnectionDetails
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
listConnectionDetailsParameters:
{
Description: Parameters for listing connection details of Azure Dev Spaces Controller. ,
Required: True ,
}
{
targetContainerHostResourceId:
{
Description: Resource ID of the target container host mapped to the Azure Dev Spaces Controller. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
connectionDetailsList:
{
Description: List of Azure Dev Spaces Controller connection details. ,
Required: False ,
}
[
{
orchestratorSpecificConnectionDetails:
{
Description: Base class for types that supply values used to connect to container orchestrators ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing the error in detail. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}