获取环境

命名空间: microsoft.graph.security

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

获取与区域关联的特定环境。 环境 ID 必须是 URL 编码的。

API 可用性

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Zone.Read.All Zone.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Zone.Read.All Zone.ReadWrite.All

重要

对于使用工作或学校帐户的委派访问权限,必须为登录用户分配受支持的 Microsoft Entra 角色 或授予此操作所需权限的自定义角色。 此操作支持以下内置角色,这些角色仅提供所需的最小权限:

  • 安全管理员
  • 全局读取者
  • 安全读取者

HTTP 请求

GET /security/zones/{zoneId}/environments/{environmentId}

可选的查询参数

此方法支持 $select OData 查询参数,以帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法将在响应正文中返回 200 OK 响应代码和 microsoft.graph.security.environment 对象。

示例

示例 1:获取 AWS 帐户环境

请求

以下示例显示了获取 AWS 账户环境的请求。

GET https://graph.microsoft.com/beta/security/zones/05cfec937c214892a14448562ef4bf4a/environments/181994123251

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/security/zones/$metadata#environments/$entity",
  "@odata.type": "#microsoft.graph.security.environment",
  "kind": "awsAccount",
  "id": "181994123251"
}

示例 2: 获取 Azure 订阅环境

Azure 订阅的环境 ID 使用该 /subscriptions/{subscription-id} 格式,在请求 URL 中使用时必须进行 URL 编码。

格式 值
Original /subscriptions/18d1c06d-520b-46d1-b309-be218fbc811e
URL 编码的 %2Fsubscriptions%2F18d1c06d-520b-46d1-b309-be218fbc811e

请求

以下示例显示了获取具有 URL 编码环境 ID 的 Azure 订阅环境的请求。

GET https://graph.microsoft.com/beta/security/zones/05cfec937c214892a14448562ef4bf4a/environments/%2Fsubscriptions%2F18d1c06d-520b-46d1-b309-be218fbc811e

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/security/zones/$metadata#environments/$entity",
  "@odata.type": "#microsoft.graph.security.environment",
  "kind": "azureSubscription",
  "id": "/subscriptions/18d1c06d-520b-46d1-b309-be218fbc811e"
}