获取 bitlockerRecoveryKey
命名空间:microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
检索 bitlockerRecoveryKey 对象的属性和关系。
默认情况下,此操作不会返回表示实际恢复密钥的 key 属性。 若要在 响应中包括 key 属性,请使用 $select OData 查询参数。 $select包含查询参数将触发Azure AD审核,并生成一个审核日志。 可以在"KeyManagement"类别Azure AD审核日志中找到日志。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 |
权限(从最高特权到最低特权) |
| 委派(工作或学校帐户) |
BitLockerKey.ReadBasic.All、BitLockerKey.Read.All |
| 委派(个人 Microsoft 帐户) |
不支持 |
| 应用程序 |
不支持 |
注意: 对于允许应用代表登录用户获取 BitLockerRecoveryKey 资源的委派权限,租户管理员必须为用户分配以下角色之一,或者用户必须是最初备份 BitLocker 密钥的设备注册所有者:
- 全局管理员
- 云设备管理员
- 支持人员管理员
- Intune 服务管理员
- 安全管理员
- 安全读者
- 全局读取者
HTTP 请求
在不返回 key 属性的情况下获取指定的 BitLocker 密钥:
GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}
若要获取指定的 BitLocker 密钥(包括其 key 属性):
GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}?$select=key
可选的查询参数
此方法支持 OData $select 查询参数返回 key 属性。 有关详细信息,请参阅示例 2。 若要了解一般信息,请参阅 OData 查询参数。
| 名称 |
说明 |
| Authorization |
Bearer {token}。必需。 |
| User-Agent |
调用应用程序的标识符。 此值包含有关使用的操作系统和浏览器的信息。 必需项。 |
| ocp-client-name |
执行 API 调用的客户端应用程序的名称。 此标头用于调试目的。 可选。 |
| ocp-client-version |
执行 API 调用的客户端应用程序的版本。 此标头用于调试目的。 可选。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应 200 OK 正文中返回 响应代码和 bitlockerRecoveryKey 对象。
示例
示例 1
通过指定密钥 ID 获取 BitLocker 密钥。本示例不返回 key 属性。
请求
下面展示了示例请求。
GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4
User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client"
ocp-client-version: "1.2"
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var bitlockerRecoveryKey = await graphClient.InformationProtection.Bitlocker.RecoveryKeys["{bitlockerRecoveryKey-id}"]
.Request()
.Header("ocp-client-name","\"My Friendly Client\"")
.Header("ocp-client-version","\"1.2\"")
.GetAsync();
const options = {
authProvider,
};
const client = Client.init(options);
let bitlockerRecoveryKey = await client.api('/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4')
.version('beta')
.header('ocp-client-name','"My Friendly Client"')
.header('ocp-client-version','"1.2"')
.get();
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4"]]];
[urlRequest setHTTPMethod:@"GET"];
[urlRequest setValue:@"\"My Friendly Client\"" forHTTPHeaderField:@"ocp-client-name"];
[urlRequest setValue:@"\"1.2\"" forHTTPHeaderField:@"ocp-client-version"];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
MSGraphBitlockerRecoveryKey *bitlockerRecoveryKey = [[MSGraphBitlockerRecoveryKey alloc] initWithData:data error:&nserror];
}];
[meDataTask execute];
GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new HeaderOption("ocp-client-name", "\"My Friendly Client\""));
requestOptions.add(new HeaderOption("ocp-client-version", "\"1.2\""));
BitlockerRecoveryKey bitlockerRecoveryKey = graphClient.informationProtection().bitlocker().recoveryKeys("b465e4e8-e4e8-b465-e8e4-65b4e8e465b4")
.buildRequest( requestOptions )
.get();
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
headers := map[string]string{
"ocp-client-name": ""My Friendly Client""
"ocp-client-version": ""1.2""
}
options := &msgraphsdk.BitlockerRecoveryKeyRequestBuilderGetOptions{
H: headers,
}
bitlockerRecoveryKeyId := "bitlockerRecoveryKey-id"
result, err := graphClient.InformationProtection().Bitlocker().RecoveryKeysById(&bitlockerRecoveryKeyId).Get(options)
Import-Module Microsoft.Graph.Identity.SignIns
Get-MgInformationProtectionBitlockerRecoveryKey -BitlockerRecoveryKeyId $bitlockerRecoveryKeyId
响应
下面展示了示例响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
"id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
"createdDateTime": "2020-06-15T13:45:30.0000000Z",
"volumeType": 1,
"deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9"
}
}
示例 2
通过指定密钥 ID 获取 具有 key 属性的 BitLocker 密钥。
请求
下面展示了示例请求。
GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4?$select=key
User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client"
ocp-client-version: "1.2"
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var bitlockerRecoveryKey = await graphClient.InformationProtection.Bitlocker.RecoveryKeys["{bitlockerRecoveryKey-id}"]
.Request()
.Select("key")
.GetAsync();
const options = {
authProvider,
};
const client = Client.init(options);
let bitlockerRecoveryKey = await client.api('/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4')
.version('beta')
.select('key')
.get();
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4?$select=key"]]];
[urlRequest setHTTPMethod:@"GET"];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
MSGraphBitlockerRecoveryKey *bitlockerRecoveryKey = [[MSGraphBitlockerRecoveryKey alloc] initWithData:data error:&nserror];
}];
[meDataTask execute];
GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
BitlockerRecoveryKey bitlockerRecoveryKey = graphClient.informationProtection().bitlocker().recoveryKeys("b465e4e8-e4e8-b465-e8e4-65b4e8e465b4")
.buildRequest()
.select("key")
.get();
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
requestParameters := &msgraphsdk.BitlockerRecoveryKeyRequestBuilderGetQueryParameters{
Select: "key",
}
options := &msgraphsdk.BitlockerRecoveryKeyRequestBuilderGetOptions{
Q: requestParameters,
}
bitlockerRecoveryKeyId := "bitlockerRecoveryKey-id"
result, err := graphClient.InformationProtection().Bitlocker().RecoveryKeysById(&bitlockerRecoveryKeyId).Get(options)
Import-Module Microsoft.Graph.Identity.SignIns
Get-MgInformationProtectionBitlockerRecoveryKey -BitlockerRecoveryKeyId $bitlockerRecoveryKeyId -Property "key"
响应
下面展示了示例响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
"id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
"createdDateTime": "String (timestamp)",
"volumeType": 1,
"deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9",
"key": "123456-231453-873456-213546-654678-765689-123456-324565"
}
}