Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Cree un nuevo objeto cloudPcPool .
Esta API está disponible en las siguientes implementaciones nacionales de nube.
| Servicio global |
Gobierno de EE. UU. L4 |
Us Government L5 (DOD) |
China operada por 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso |
Permisos con privilegios mínimos |
Permisos con privilegios más altos |
| Delegado (cuenta profesional o educativa) |
CloudPC. ReadWrite. All |
No disponible. |
| Delegado (cuenta personal de Microsoft) |
No admitida. |
No admitida. |
| Aplicación |
CloudPC. ReadWrite. All |
No disponible. |
Solicitud HTTP
POST /deviceManagement/virtualEndpoint/cloudPcPools
| Nombre |
Descripción |
| Authorization |
{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
| Content-Type |
application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione una representación JSON de un objeto cloudPcPool .
La propiedad @odata.type es necesaria en el cuerpo de la solicitud para especificar el tipo derivado. El valor admitido es #microsoft.graph.cloudPcAgentPool.
En la tabla siguiente se enumeran las propiedades necesarias al crear un cloudPcPool.
| Propiedad |
Tipo |
Descripción |
| billingConfiguration |
cloudPcAgentPoolBillingConfiguration |
Obligatorio. Configuración de facturación del grupo de agentes, incluido el tipo de facturación y el identificador del plan de facturación. Se aplica al tipo derivado cloudPcAgentPool . |
| capabilities |
cloudPcPoolCapabilityConfiguration |
Obligatorio. La configuración de funcionalidades del grupo, incluida la configuración de inicio de sesión único. |
| cloudPcConfiguration |
cloudPcConfiguration |
Obligatorio. Especificación del equipo en la nube, incluida la configuración regional de la imagen y del sistema operativo para el aprovisionamiento. |
| description |
Cadena |
Opcional. Descripción del grupo. La longitud máxima es de 512 caracteres. |
| displayName |
Cadena |
Obligatorio. Nombre para mostrar del grupo. El nombre es único en los grupos de equipos en la nube de una organización. La longitud máxima es de 60 caracteres. |
| networkConfiguration |
cloudPcNetworkConfiguration |
Obligatorio. Configuración de red para el grupo. Tipos derivados admitidos: cloudPcMicrosoftHostedNetworkConfiguration. |
| scalingPolicy |
cloudPcAgentPoolScalingPolicy |
Obligatorio. La directiva de escalado que define los recuentos mínimo y máximo de equipos en la nube para el grupo. Se aplica al tipo derivado cloudPcAgentPool . |
Respuesta
Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto cloudPcPool en el cuerpo de la respuesta.
Ejemplos
Solicitud
En el ejemplo siguiente se muestra la solicitud.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPcPools
Content-Type: application/json
{
"@odata.type":"#microsoft.graph.cloudPcAgentPool",
"displayName": "Contoso Development Pool",
"cloudPcConfiguration": {
"imageId": "microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365",
"imageType": "gallery",
"osLocale": "en-US"
},
"networkConfiguration": {
"@odata.type": "#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration",
"geographicLocationType": "usWest",
"regionGroups": [
{
"regionGroup": "usWest",
"regions": ["westus2", "westus3"]
}
]
},
"billingConfiguration": {
"billingType": "payAsYouGo",
"billingPlanId": "00000000-0000-0000-0000-000000000001"
},
"scalingPolicy": {
"minimumCount": 2,
"maximumCount": 10
},
"capabilities": {
"@odata.type": "#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration",
"enableSingleSignOn": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new CloudPcAgentPool
{
OdataType = "#microsoft.graph.cloudPcAgentPool",
DisplayName = "Contoso Development Pool",
CloudPcConfiguration = new CloudPcConfiguration
{
ImageId = "microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365",
ImageType = CloudPcProvisioningPolicyImageType.Gallery,
OsLocale = "en-US",
},
NetworkConfiguration = new CloudPcMicrosoftHostedNetworkConfiguration
{
OdataType = "#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration",
GeographicLocationType = CloudPcGeographicLocationType.UsWest,
RegionGroups = new List<CloudPcRegionGroupConfiguration>
{
new CloudPcRegionGroupConfiguration
{
RegionGroup = CloudPcRegionGroup.UsWest,
Regions = new List<string>
{
"westus2",
"westus3",
},
},
},
},
BillingConfiguration = new CloudPcAgentPoolBillingConfiguration
{
BillingType = CloudPcAgentPoolBillingType.PayAsYouGo,
BillingPlanId = "00000000-0000-0000-0000-000000000001",
},
ScalingPolicy = new CloudPcAgentPoolScalingPolicy
{
MinimumCount = 2,
MaximumCount = 10,
},
Capabilities = new CloudPcAgentPoolCapabilityConfiguration
{
OdataType = "#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration",
EnableSingleSignOn = true,
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.VirtualEndpoint.CloudPcPools.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewCloudPcPool()
displayName := "Contoso Development Pool"
requestBody.SetDisplayName(&displayName)
cloudPcConfiguration := graphmodels.NewCloudPcConfiguration()
imageId := "microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365"
cloudPcConfiguration.SetImageId(&imageId)
imageType := graphmodels.GALLERY_CLOUDPCPROVISIONINGPOLICYIMAGETYPE
cloudPcConfiguration.SetImageType(&imageType)
osLocale := "en-US"
cloudPcConfiguration.SetOsLocale(&osLocale)
requestBody.SetCloudPcConfiguration(cloudPcConfiguration)
networkConfiguration := graphmodels.NewCloudPcMicrosoftHostedNetworkConfiguration()
geographicLocationType := graphmodels.USWEST_CLOUDPCGEOGRAPHICLOCATIONTYPE
networkConfiguration.SetGeographicLocationType(&geographicLocationType)
cloudPcRegionGroupConfiguration := graphmodels.NewCloudPcRegionGroupConfiguration()
regionGroup := graphmodels.USWEST_CLOUDPCREGIONGROUP
cloudPcRegionGroupConfiguration.SetRegionGroup(®ionGroup)
regions := []string {
"westus2",
"westus3",
}
cloudPcRegionGroupConfiguration.SetRegions(regions)
regionGroups := []graphmodels.CloudPcRegionGroupConfigurationable {
cloudPcRegionGroupConfiguration,
}
networkConfiguration.SetRegionGroups(regionGroups)
requestBody.SetNetworkConfiguration(networkConfiguration)
billingConfiguration := graphmodels.NewCloudPcAgentPoolBillingConfiguration()
billingType := graphmodels.PAYASYOUGO_CLOUDPCAGENTPOOLBILLINGTYPE
billingConfiguration.SetBillingType(&billingType)
billingPlanId := "00000000-0000-0000-0000-000000000001"
billingConfiguration.SetBillingPlanId(&billingPlanId)
requestBody.SetBillingConfiguration(billingConfiguration)
scalingPolicy := graphmodels.NewCloudPcAgentPoolScalingPolicy()
minimumCount := int32(2)
scalingPolicy.SetMinimumCount(&minimumCount)
maximumCount := int32(10)
scalingPolicy.SetMaximumCount(&maximumCount)
requestBody.SetScalingPolicy(scalingPolicy)
capabilities := graphmodels.NewCloudPcAgentPoolCapabilityConfiguration()
enableSingleSignOn := true
capabilities.SetEnableSingleSignOn(&enableSingleSignOn)
requestBody.SetCapabilities(capabilities)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
cloudPcPools, err := graphClient.DeviceManagement().VirtualEndpoint().CloudPcPools().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPcAgentPool cloudPcPool = new CloudPcAgentPool();
cloudPcPool.setOdataType("#microsoft.graph.cloudPcAgentPool");
cloudPcPool.setDisplayName("Contoso Development Pool");
CloudPcConfiguration cloudPcConfiguration = new CloudPcConfiguration();
cloudPcConfiguration.setImageId("microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365");
cloudPcConfiguration.setImageType(CloudPcProvisioningPolicyImageType.Gallery);
cloudPcConfiguration.setOsLocale("en-US");
cloudPcPool.setCloudPcConfiguration(cloudPcConfiguration);
CloudPcMicrosoftHostedNetworkConfiguration networkConfiguration = new CloudPcMicrosoftHostedNetworkConfiguration();
networkConfiguration.setOdataType("#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration");
networkConfiguration.setGeographicLocationType(CloudPcGeographicLocationType.UsWest);
LinkedList<CloudPcRegionGroupConfiguration> regionGroups = new LinkedList<CloudPcRegionGroupConfiguration>();
CloudPcRegionGroupConfiguration cloudPcRegionGroupConfiguration = new CloudPcRegionGroupConfiguration();
cloudPcRegionGroupConfiguration.setRegionGroup(CloudPcRegionGroup.UsWest);
LinkedList<String> regions = new LinkedList<String>();
regions.add("westus2");
regions.add("westus3");
cloudPcRegionGroupConfiguration.setRegions(regions);
regionGroups.add(cloudPcRegionGroupConfiguration);
networkConfiguration.setRegionGroups(regionGroups);
cloudPcPool.setNetworkConfiguration(networkConfiguration);
CloudPcAgentPoolBillingConfiguration billingConfiguration = new CloudPcAgentPoolBillingConfiguration();
billingConfiguration.setBillingType(CloudPcAgentPoolBillingType.PayAsYouGo);
billingConfiguration.setBillingPlanId("00000000-0000-0000-0000-000000000001");
cloudPcPool.setBillingConfiguration(billingConfiguration);
CloudPcAgentPoolScalingPolicy scalingPolicy = new CloudPcAgentPoolScalingPolicy();
scalingPolicy.setMinimumCount(2);
scalingPolicy.setMaximumCount(10);
cloudPcPool.setScalingPolicy(scalingPolicy);
CloudPcAgentPoolCapabilityConfiguration capabilities = new CloudPcAgentPoolCapabilityConfiguration();
capabilities.setOdataType("#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration");
capabilities.setEnableSingleSignOn(true);
cloudPcPool.setCapabilities(capabilities);
CloudPcPool result = graphClient.deviceManagement().virtualEndpoint().cloudPcPools().post(cloudPcPool);
const options = {
authProvider,
};
const client = Client.init(options);
const cloudPcPool = {
'@odata.type':'#microsoft.graph.cloudPcAgentPool',
displayName: 'Contoso Development Pool',
cloudPcConfiguration: {
imageId: 'microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365',
imageType: 'gallery',
osLocale: 'en-US'
},
networkConfiguration: {
'@odata.type': '#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration',
geographicLocationType: 'usWest',
regionGroups: [
{
regionGroup: 'usWest',
regions: ['westus2', 'westus3']
}
]
},
billingConfiguration: {
billingType: 'payAsYouGo',
billingPlanId: '00000000-0000-0000-0000-000000000001'
},
scalingPolicy: {
minimumCount: 2,
maximumCount: 10
},
capabilities: {
'@odata.type': '#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration',
enableSingleSignOn: true
}
};
await client.api('/deviceManagement/virtualEndpoint/cloudPcPools')
.version('beta')
.post(cloudPcPool);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CloudPcAgentPool;
use Microsoft\Graph\Beta\Generated\Models\CloudPcConfiguration;
use Microsoft\Graph\Beta\Generated\Models\CloudPcProvisioningPolicyImageType;
use Microsoft\Graph\Beta\Generated\Models\CloudPcMicrosoftHostedNetworkConfiguration;
use Microsoft\Graph\Beta\Generated\Models\CloudPcGeographicLocationType;
use Microsoft\Graph\Beta\Generated\Models\CloudPcRegionGroupConfiguration;
use Microsoft\Graph\Beta\Generated\Models\CloudPcRegionGroup;
use Microsoft\Graph\Beta\Generated\Models\CloudPcAgentPoolBillingConfiguration;
use Microsoft\Graph\Beta\Generated\Models\CloudPcAgentPoolBillingType;
use Microsoft\Graph\Beta\Generated\Models\CloudPcAgentPoolScalingPolicy;
use Microsoft\Graph\Beta\Generated\Models\CloudPcAgentPoolCapabilityConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CloudPcAgentPool();
$requestBody->setOdataType('#microsoft.graph.cloudPcAgentPool');
$requestBody->setDisplayName('Contoso Development Pool');
$cloudPcConfiguration = new CloudPcConfiguration();
$cloudPcConfiguration->setImageId('microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365');
$cloudPcConfiguration->setImageType(new CloudPcProvisioningPolicyImageType('gallery'));
$cloudPcConfiguration->setOsLocale('en-US');
$requestBody->setCloudPcConfiguration($cloudPcConfiguration);
$networkConfiguration = new CloudPcMicrosoftHostedNetworkConfiguration();
$networkConfiguration->setOdataType('#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration');
$networkConfiguration->setGeographicLocationType(new CloudPcGeographicLocationType('usWest'));
$regionGroupsCloudPcRegionGroupConfiguration1 = new CloudPcRegionGroupConfiguration();
$regionGroupsCloudPcRegionGroupConfiguration1->setRegionGroup(new CloudPcRegionGroup('usWest'));
$regionGroupsCloudPcRegionGroupConfiguration1->setRegions(['westus2', 'westus3', ]);
$regionGroupsArray []= $regionGroupsCloudPcRegionGroupConfiguration1;
$networkConfiguration->setRegionGroups($regionGroupsArray);
$requestBody->setNetworkConfiguration($networkConfiguration);
$billingConfiguration = new CloudPcAgentPoolBillingConfiguration();
$billingConfiguration->setBillingType(new CloudPcAgentPoolBillingType('payAsYouGo'));
$billingConfiguration->setBillingPlanId('00000000-0000-0000-0000-000000000001');
$requestBody->setBillingConfiguration($billingConfiguration);
$scalingPolicy = new CloudPcAgentPoolScalingPolicy();
$scalingPolicy->setMinimumCount(2);
$scalingPolicy->setMaximumCount(10);
$requestBody->setScalingPolicy($scalingPolicy);
$capabilities = new CloudPcAgentPoolCapabilityConfiguration();
$capabilities->setOdataType('#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration');
$capabilities->setEnableSingleSignOn(true);
$requestBody->setCapabilities($capabilities);
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->cloudPcPools()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.cloud_pc_agent_pool import CloudPcAgentPool
from msgraph_beta.generated.models.cloud_pc_configuration import CloudPcConfiguration
from msgraph_beta.generated.models.cloud_pc_provisioning_policy_image_type import CloudPcProvisioningPolicyImageType
from msgraph_beta.generated.models.cloud_pc_microsoft_hosted_network_configuration import CloudPcMicrosoftHostedNetworkConfiguration
from msgraph_beta.generated.models.cloud_pc_geographic_location_type import CloudPcGeographicLocationType
from msgraph_beta.generated.models.cloud_pc_region_group_configuration import CloudPcRegionGroupConfiguration
from msgraph_beta.generated.models.cloud_pc_region_group import CloudPcRegionGroup
from msgraph_beta.generated.models.cloud_pc_agent_pool_billing_configuration import CloudPcAgentPoolBillingConfiguration
from msgraph_beta.generated.models.cloud_pc_agent_pool_billing_type import CloudPcAgentPoolBillingType
from msgraph_beta.generated.models.cloud_pc_agent_pool_scaling_policy import CloudPcAgentPoolScalingPolicy
from msgraph_beta.generated.models.cloud_pc_agent_pool_capability_configuration import CloudPcAgentPoolCapabilityConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CloudPcAgentPool(
odata_type = "#microsoft.graph.cloudPcAgentPool",
display_name = "Contoso Development Pool",
cloud_pc_configuration = CloudPcConfiguration(
image_id = "microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365",
image_type = CloudPcProvisioningPolicyImageType.Gallery,
os_locale = "en-US",
),
network_configuration = CloudPcMicrosoftHostedNetworkConfiguration(
odata_type = "#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration",
geographic_location_type = CloudPcGeographicLocationType.UsWest,
region_groups = [
CloudPcRegionGroupConfiguration(
region_group = CloudPcRegionGroup.UsWest,
regions = [
"westus2",
"westus3",
],
),
],
),
billing_configuration = CloudPcAgentPoolBillingConfiguration(
billing_type = CloudPcAgentPoolBillingType.PayAsYouGo,
billing_plan_id = "00000000-0000-0000-0000-000000000001",
),
scaling_policy = CloudPcAgentPoolScalingPolicy(
minimum_count = 2,
maximum_count = 10,
),
capabilities = CloudPcAgentPoolCapabilityConfiguration(
odata_type = "#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration",
enable_single_sign_on = True,
),
)
result = await graph_client.device_management.virtual_endpoint.cloud_pc_pools.post(request_body)
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Contoso Development Pool",
"cloudPcConfiguration": {
"imageId": "microsoftwindowsdesktop_windows-ent-cpc_win11-23h2-ent-cpc-m365",
"imageType": "gallery",
"osLocale": "en-US"
},
"networkConfiguration": {
"@odata.type": "#microsoft.graph.cloudPcMicrosoftHostedNetworkConfiguration",
"geographicLocationType": "usWest",
"regionGroups": [
{
"regionGroup": "usWest",
"regions": [
"westus2",
"westus3"
]
}
]
},
"billingConfiguration": {
"billingType": "payAsYouGo",
"billingPlanId": "00000000-0000-0000-0000-000000000001"
},
"scalingPolicy": {
"minimumCount": 2,
"maximumCount": 10
},
"capabilities": {
"@odata.type": "#microsoft.graph.cloudPcAgentPoolCapabilityConfiguration",
"enableSingleSignOn": true
}
}