列出应用程序
本文内容
命名空间:microsoft.graph
获取该组织中应用程序 的列表。
备注
使用为个人 Microsoft 帐户颁发的令牌调用此 API 时,将返回个人 Microsoft 帐户所拥有的应用。 个人 Microsoft 帐户不存在组织概念。 为了列出特定个人 Microsoft 帐户所拥有的应用程序,此 API 需要用户。除 Application.Read.All 或 Application.ReadWrite.All 之外,还读取权限。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限 。
权限类型
权限(从最低特权到最高特权)
委派(工作或学校帐户)
Application.Read.All、Application.ReadWrite.All、Directory.Read.All
委派(个人 Microsoft 帐户)
Application.Read.All 和 User.Read, Application.ReadWrite.All 和 User.Read
应用程序
Application.Read.All、Application.ReadWrite.OwnedBy、Application.ReadWrite.All、Directory.Read.All
HTTP 请求
GET /applications
可选的查询参数
此方法支持使用 $count、$expand、$filter、$orderBy、$search、$select 和 $top OData 查询参数 以帮助自定义响应。 默认和最大页面大小分别为 100 和 999 个应用程序对象。 只有将 ConsistencyLevel 标头设置为 eventual 和 $count 时,才支持某些查询。 有关详细信息,请参阅 Azure AD 目录对象的高级查询功能 。
默认情况下,在列出所有应用程序时,此 API 不会在 keyCredentials 属性中返回 键 的值。 要检索 密钥 中的公钥信息,必须在 $select 查询中指定 keyCredentials 属性。 例如,$select=id,appId,keyCredentials。
对于每个租户,使用 $select 获取应用程序的 keyCredentials 的限制为每分钟 150 个请求。
名称
说明
Authorization
Bearer {token}。必需。
ConsistencyLevel
最终。 当使用 $search 或 $filter 的特定用法时,需要此标头和 $count。 有关使用 ConsistencyLevel 和 $count 的详细信息,请参阅 Azure AD 目录对象的高级查询功能 。
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回 200 OK 响应代码和 application 对象集合。
示例
示例 1:获取应用程序列表
请求
下面是一个请求示例。
GET https://graph.microsoft.com/v1.0/applications
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var applications = await graphClient.Applications
.Request()
.GetAsync();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
let applications = await client.api('/applications')
.get();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/applications"]]];
[urlRequest setHTTPMethod:@"GET"];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
NSError *jsonError = nil;
MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
MSGraphApplication *application = [[MSGraphApplication alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];
}];
[meDataTask execute];
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
ApplicationCollectionPage applications = graphClient.applications()
.buildRequest()
.get();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
result, err := graphClient.Applications().Get()
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
响应
下面是一个响应示例。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#applications",
"value": [
{
"appId": "00000000-0000-0000-0000-000000000000",
"identifierUris": [ "http://contoso/" ],
"displayName": "My app",
"publisherDomain": "contoso.com",
"signInAudience": "AzureADMyOrg"
}
]
}
示例 2:仅获取应用程序计数
请求
下面展示了示例请求。 此请求要求将 ConsistencyLevel 标头设置为 eventual,因为在请求中有 $count。 有关使用 ConsistencyLevel 和 $count 的详细信息,请参阅 Azure AD 目录对象的高级查询功能 。
注意: $count和$search 查询参数当前在 Azure AD B2C 租户中不可用。
GET https://graph.microsoft.com/v1.0/applications/$count
ConsistencyLevel: eventual
响应
下面展示了示例响应。
HTTP/1.1 200 OK
Content-type: text/plain
893
示例 3:使用 $filter 和 $top 获取一个显示名称以“a”开头的应用程序,其中包括返回的对象数
请求
下面展示了示例请求。 此请求需要将 ConsistencyLevel 标头设置为 eventual 和 $count=true 查询字符串,因为请求同时具有 $orderBy 和 $filter 查询参数。 有关使用 ConsistencyLevel 和 $count 的详细信息,请参阅 Azure AD 目录对象的高级查询功能 。
注意: $count和$search 查询参数当前在 Azure AD B2C 租户中不可用。
GET https://graph.microsoft.com/v1.0/applications?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName
ConsistencyLevel: eventual
响应
下面展示了示例响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#applications",
"@odata.count":1,
"value":[
{
"appId": "00000000-0000-0000-0000-000000000000",
"identifierUris": [ "http://contoso/" ],
"displayName":"a",
"publisherDomain": "contoso.com",
"signInAudience": "AzureADMyOrg"
}
]
}
示例 4:使用 $search 获取显示名称中包含字母“Web”的应用程序,其中包括返回的对象数
请求
下面展示了示例请求。 此请求要求将 ConsistencyLevel 标头设置为 eventual,因为在请求中有 $search 和 $count=true 查询字符串。 有关使用 ConsistencyLevel 和 $count 的详细信息,请参阅 Azure AD 目录对象的高级查询功能 。
注意: $count和$search 查询参数当前在 Azure AD B2C 租户中不可用。
GET https://graph.microsoft.com/v1.0/applications?$search="displayName:Web"&$count=true
ConsistencyLevel: eventual
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var queryOptions = new List<QueryOption>()
{
new QueryOption("$count", "true")
};
var applications = await graphClient.Applications
.Request( queryOptions )
.Header("ConsistencyLevel","eventual")
.Search("displayName:Web")
.GetAsync();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
let applications = await client.api('/applications')
.header('ConsistencyLevel','eventual')
.search('displayName:Web')
.get();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/applications?$search=%22displayName:Web%22&$count=true"]]];
[urlRequest setHTTPMethod:@"GET"];
[urlRequest setValue:@"eventual" forHTTPHeaderField:@"ConsistencyLevel"];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
NSError *jsonError = nil;
MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
MSGraphApplication *application = [[MSGraphApplication alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];
}];
[meDataTask execute];
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new HeaderOption("ConsistencyLevel", "eventual"));
requestOptions.add(new QueryOption("$search", "displayName:Web"));
ApplicationCollectionPage applications = graphClient.applications()
.buildRequest( requestOptions )
.get();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
requestParameters := &msgraphsdk.ApplicationsRequestBuilderGetQueryParameters{
Search: "%22displayName:Web%22",
Count: true,
}
headers := map[string]string{
"ConsistencyLevel": "eventual"
}
options := &msgraphsdk.ApplicationsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
Headers: headers,
}
result, err := graphClient.Applications().GetWithRequestConfigurationAndResponseHandler(options, nil)
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.Applications
Get-MgApplication -Search "displayName:Web" -CountVariable CountVar -ConsistencyLevel eventual
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
响应
下面展示了示例响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#applications",
"@odata.count":1396,
"value":[
{
"appId": "00000000-0000-0000-0000-000000000000",
"identifierUris": [ "http://contoso/" ],
"displayName":"'DotNetWeb-App' ",
"publisherDomain": "contoso.com",
"signInAudience": "AzureADMyOrg"
}
]
}