名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
状態別にグループ化された クラウド PC の数を取得します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
CloudPC.Read.All |
CloudPC.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
CloudPC.Read.All |
CloudPC.ReadWrite.All |
HTTP 要求
GET /deviceManagement/virtualEndpoint/cloudPCs/retrieveCloudPcCountByStatus?customFilter={customFilter}
関数パラメーター
要求 URL に、次のパラメーターと有効な値を指定します。
| パラメーター |
型 |
説明 |
| customFilter |
文字列 |
$filter クエリ パラメーターと同じ方法で応答を調整します。
$filter クエリ パラメーターを使用してオブジェクトのコレクションをフィルター処理する方法の詳細については、「$filter クエリ パラメーターを使用する」を参照してください。 |
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文の cloudPcStatusSummary オブジェクトのコレクションを返します。
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/retrieveCloudPcCountByStatus?customFilter=contains(tolower(managedDeviceName), 'a') or contains(tolower(imageDisplayName), 'a') or contains(tolower(userPrincipalName), 'a')
// Code snippets are only available for the latest version. Current version is 5.x
// 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.CloudPCs.RetrieveCloudPcCountByStatus.GetAsRetrieveCloudPcCountByStatusGetResponseAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.CustomFilter = "contains(tolower(managedDeviceName), 'a') or contains(tolower(imageDisplayName), 'a') or contains(tolower(userPrincipalName), 'a')";
});
// 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"
graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
//other-imports
)
requestCustomFilter := "contains(tolower(managedDeviceName), 'a') or contains(tolower(imageDisplayName), 'a') or contains(tolower(userPrincipalName), 'a')"
requestParameters := &graphdevicemanagement.VirtualEndpointCloudPCsRetrieveCloudPcCountByStatusRequestBuilderGetQueryParameters{
CustomFilter: &requestCustomFilter,
}
configuration := &graphdevicemanagement.VirtualEndpointCloudPCsRetrieveCloudPcCountByStatusRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
retrieveCloudPcCountByStatus, err := graphClient.DeviceManagement().VirtualEndpoint().CloudPCs().RetrieveCloudPcCountByStatus().GetAsRetrieveCloudPcCountByStatusGetResponse(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
var result = graphClient.deviceManagement().virtualEndpoint().cloudPCs().retrieveCloudPcCountByStatus().get(requestConfiguration -> {
requestConfiguration.queryParameters.customFilter = "contains(tolower(managedDeviceName), 'a') or contains(tolower(imageDisplayName), 'a') or contains(tolower(userPrincipalName), 'a')";
});
const options = {
authProvider,
};
const client = Client.init(options);
let retrieveCloudPcCountByStatus = await client.api('/deviceManagement/virtualEndpoint/cloudPCs/retrieveCloudPcCountByStatus?customFilter=contains(tolower(managedDeviceName), \'a\') or contains(tolower(imageDisplayName), \'a\') or contains(tolower(userPrincipalName), \'a\')')
.version('beta')
.filter('contains(tolower(managedDeviceName), \'a\') or contains(tolower(imageDisplayName), \'a\') or contains(tolower(userPrincipalName), \'a\')')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\CloudPCs\RetrieveCloudPcCountByStatus\RetrieveCloudPcCountByStatusRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new RetrieveCloudPcCountByStatusRequestBuilderGetRequestConfiguration();
$queryParameters = RetrieveCloudPcCountByStatusRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->customFilter = "contains(tolower(managedDeviceName), 'a') or contains(tolower(imageDisplayName), 'a') or contains(tolower(userPrincipalName), 'a')";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->cloudPCs()->retrieveCloudPcCountByStatus()->get($requestConfiguration)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.device_management.virtual_endpoint.cloud_p_cs.retrieve_cloud_pc_count_by_status.retrieve_cloud_pc_count_by_status_request_builder import RetrieveCloudPcCountByStatusRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = RetrieveCloudPcCountByStatusRequestBuilder.RetrieveCloudPcCountByStatusRequestBuilderGetQueryParameters(
custom_filter = "contains(tolower(managedDeviceName), 'a') or contains(tolower(imageDisplayName), 'a') or contains(tolower(userPrincipalName), 'a')",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.device_management.virtual_endpoint.cloud_p_cs.retrieve_cloud_pc_count_by_status.get(request_configuration = request_configuration)
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.cloudPcStatusSummary)",
"value": [
{
"status": "provisioned",
"count": 22
},
{
"status": "failed",
"count": 11
}
]
}