Create environment

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create an environment object to attach it to a zone. You can create up to 1,000 environments per zone.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Zone.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Zone.ReadWrite.All	Not available.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

• Security Administrator

HTTP request

POST /security/zones/{zoneId}/environments

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the environment object.

You can specify the following properties when you create an environment.

Property	Type	Description
id	String	Environment identifier. Required.
kind	microsoft.graph.security.environmentKind	Environment type. The possible values are: azureSubscription, awsOrganization, awsAccount, gcpOrganization, gcpProject, dockersHubOrganization, devOpsConnection, azureDevOpsOrganization, gitHubOrganization, gitLabGroup, jFrogArtifactory, unknownFutureValue. Required.

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.security.environment object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/zones/f6e190cba2f64bcba703694aedb81712/environments
Content-Type: application/json

{
  "kind": "azureSubscription",
  "id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/security/$metadata#environments/$entity",
  "@odata.type": "#microsoft.graph.security.environment",
  "kind": "azureSubscription",
  "id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15"
}