Microsoft.DesktopVirtualization (preview:2024-08-08)

2025/05/16 • 2 updated methods

PrivateEndpointConnections_ListByHostPool (updated)
Description :  List a PrivateEndpointConnectionWithSystemData
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByHostPool",
  "Description": {
    "new": "List a PrivateEndpointConnectionWithSystemData",
    "old": "Get a PrivateEndpointConnectionWithSystemData"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections
{
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 ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnectionWithSystemData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByWorkspace (updated)
Description :  List a PrivateEndpointConnectionWithSystemData
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByWorkspace",
  "Description": {
    "new": "List a PrivateEndpointConnectionWithSystemData",
    "old": "Get a PrivateEndpointConnectionWithSystemData"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections
{
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 ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnectionWithSystemData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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