List onPremisesAgents
本文内容
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
检索 onPremisesAgent 对象的列表。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
✅
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型 。 要了解有关这些权限的详细信息,请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派(工作或学校帐户)
Directory.ReadWrite.All
不可用。
委派(个人 Microsoft 帐户)
不支持。
不支持。
应用程序
不支持。
不支持。
HTTP 请求
GET /onPremisesPublishingProfiles/{profile-id}/agents
可选的查询参数
此方法支持使用 OData 查询参数 来帮助自定义响应。
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回响应 200 OK
代码和 onPremisesAgentGroup 对象的集合。
示例
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/onPremisesPublishingProfiles/provisioning/agents?$expand=agentGroups
// 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.OnPremisesPublishingProfiles["{onPremisesPublishingProfile-id}"].Agents.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Expand = new string []{ "agentGroups" };
});
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta on-premises-publishing-profiles agents list --on-premises-publishing-profile-id {onPremisesPublishingProfile-id} --expand "agentGroups"
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphonpremisespublishingprofiles "github.com/microsoftgraph/msgraph-beta-sdk-go/onpremisespublishingprofiles"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestParameters := &graphonpremisespublishingprofiles.OnPremisesPublishingProfileItemAgentsRequestBuilderGetQueryParameters{
Expand: [] string {"agentGroups"},
}
configuration := &graphonpremisespublishingprofiles.OnPremisesPublishingProfileItemAgentsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
agents, err := graphClient.OnPremisesPublishingProfiles().ByOnPremisesPublishingProfileId("onPremisesPublishingProfile-id").Agents().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OnPremisesAgentCollectionResponse result = graphClient.onPremisesPublishingProfiles().byOnPremisesPublishingProfileId("{onPremisesPublishingProfile-id}").agents().get(requestConfiguration -> {
requestConfiguration.queryParameters.expand = new String []{"agentGroups"};
});
const options = {
authProvider,
};
const client = Client.init(options);
let agents = await client.api('/onPremisesPublishingProfiles/provisioning/agents')
.version('beta')
.expand('agentGroups')
.get();
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\OnPremisesPublishingProfiles\Item\Agents\AgentsRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new AgentsRequestBuilderGetRequestConfiguration();
$queryParameters = AgentsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->expand = ["agentGroups"];
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->onPremisesPublishingProfiles()->byOnPremisesPublishingProfileId('onPremisesPublishingProfile-id')->agents()->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Applications
Get-MgBetaOnPremisePublishingProfileAgent -OnPremisesPublishingProfileId $onPremisesPublishingProfileId -ExpandProperty "agentGroups"
from msgraph import GraphServiceClient
from msgraph.generated.on_premises_publishing_profiles.item.agents.agents_request_builder import AgentsRequestBuilder
graph_client = GraphServiceClient(credentials, scopes)
query_params = AgentsRequestBuilder.AgentsRequestBuilderGetQueryParameters(
expand = ["agentGroups"],
)
request_configuration = AgentsRequestBuilder.AgentsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.on_premises_publishing_profiles.by_on_premises_publishing_profile_id('onPremisesPublishingProfile-id').agents.get(request_configuration = request_configuration)
响应
以下示例显示了相应的响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "1234b780-965f-4149-85c5-a8c73e58b67d",
"status": "Active",
"machineName": "server1.local1.contoso.com",
"externalIp": "153.69.23.122",
"agentGroups": [
{
"id": "2d55ed41-1619-4848-92bb-0576d3038682",
"displayName": "Group 1"
}
]
}
]
}