Governance Assignments - Create Or Update

Service:: Defender for Cloud

API Version:: 2022-01-01-preview

Creates or updates a governance assignment on the given subscription.

PUT https://management.azure.com/{scope}/providers/Microsoft.Security/assessments/{assessmentName}/governanceAssignments/{assignmentKey}?api-version=2022-01-01-preview

URI Parameters

Name	In	Required	Type	Description
assessmentName	path	True	string pattern: ^[-\w\._\(\)]+$	The Assessment Key - A unique key for the assessment type
assignmentKey	path	True	string	The governance assignment key - the assessment key of the required governance assignment
scope	path	True	string	The scope of the Governance assignments. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
api-version	query	True	string	API version for the operation

Request Body

Name	Required	Type	Description
properties.remediationDueDate	True	string (date-time)	The remediation due-date - after this date Secure Score will be affected (in case of active grace-period)
properties.additionalData		GovernanceAssignmentAdditionalData	The additional data for the governance assignment - e.g. links to ticket (optional), see example
properties.governanceEmailNotification		GovernanceEmailNotification	The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners
properties.isGracePeriod		boolean	Defines whether there is a grace period on the governance assignment
properties.owner		string	The Owner for the governance assignment - e.g. user@contoso.com - see example
properties.remediationEta		RemediationEta	The ETA (estimated time of arrival) for remediation (optional), see example

Responses

Name	Type	Description
200 OK	GovernanceAssignment	OK - Updated
201 Created	GovernanceAssignment	Created
Other Status Codes	CloudError	Error response describing why the operation failed

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create Governance assignment

Sample request

PUT https://management.azure.com/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012/providers/Microsoft.Security/assessments/6b9421dd-5555-2251-9b3d-2be58e2f82cd/governanceAssignments/6634ff9f-127b-4bf2-8e6e-b1737f5e789c?api-version=2022-01-01-preview

{
  "properties": {
    "owner": "user@contoso.com",
    "remediationDueDate": "2022-01-07T13:00:00.0000000Z",
    "remediationEta": {
      "eta": "2022-01-08T13:00:00.0000000Z",
      "justification": "Justification of ETA"
    },
    "isGracePeriod": true,
    "governanceEmailNotification": {
      "disableManagerEmailNotification": false,
      "disableOwnerEmailNotification": false
    },
    "additionalData": {
      "ticketNumber": 123123,
      "ticketLink": "https://snow.com",
      "ticketStatus": "Active"
    }
  }
}


import com.azure.resourcemanager.security.models.GovernanceAssignmentAdditionalData;
import com.azure.resourcemanager.security.models.GovernanceEmailNotification;
import com.azure.resourcemanager.security.models.RemediationEta;
import java.time.OffsetDateTime;

/**
 * Samples for GovernanceAssignments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/
     * GovernanceAssignments/PutGovernanceAssignment_example.json
     */
    /**
     * Sample code: Create Governance assignment.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createGovernanceAssignment(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.governanceAssignments().define("6634ff9f-127b-4bf2-8e6e-b1737f5e789c").withExistingAssessment(
            "subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012",
            "6b9421dd-5555-2251-9b3d-2be58e2f82cd").withOwner("user@contoso.com")
            .withRemediationDueDate(OffsetDateTime.parse("2022-01-07T13:00:00.0000000Z"))
            .withRemediationEta(new RemediationEta().withEta(OffsetDateTime.parse("2022-01-08T13:00:00.0000000Z"))
                .withJustification("Justification of ETA"))
            .withIsGracePeriod(true)
            .withGovernanceEmailNotification(new GovernanceEmailNotification()
                .withDisableManagerEmailNotification(false).withDisableOwnerEmailNotification(false))
            .withAdditionalData(new GovernanceAssignmentAdditionalData().withTicketNumber(123123)
                .withTicketLink("https://snow.com").withTicketStatus("Active"))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python put_governance_assignment_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.governance_assignments.create_or_update(
        scope="subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012",
        assessment_name="6b9421dd-5555-2251-9b3d-2be58e2f82cd",
        assignment_key="6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
        governance_assignment={
            "properties": {
                "additionalData": {"ticketLink": "https://snow.com", "ticketNumber": 123123, "ticketStatus": "Active"},
                "governanceEmailNotification": {
                    "disableManagerEmailNotification": False,
                    "disableOwnerEmailNotification": False,
                },
                "isGracePeriod": True,
                "owner": "user@contoso.com",
                "remediationDueDate": "2022-01-07T13:00:00.0000000Z",
                "remediationEta": {"eta": "2022-01-08T13:00:00.0000000Z", "justification": "Justification of ETA"},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceAssignments/PutGovernanceAssignment_example.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsecurity_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceAssignments/PutGovernanceAssignment_example.json
func ExampleGovernanceAssignmentsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGovernanceAssignmentsClient().CreateOrUpdate(ctx, "subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012", "6b9421dd-5555-2251-9b3d-2be58e2f82cd", "6634ff9f-127b-4bf2-8e6e-b1737f5e789c", armsecurity.GovernanceAssignment{
		Properties: &armsecurity.GovernanceAssignmentProperties{
			AdditionalData: &armsecurity.GovernanceAssignmentAdditionalData{
				TicketLink:   to.Ptr("https://snow.com"),
				TicketNumber: to.Ptr[int32](123123),
				TicketStatus: to.Ptr("Active"),
			},
			GovernanceEmailNotification: &armsecurity.GovernanceEmailNotification{
				DisableManagerEmailNotification: to.Ptr(false),
				DisableOwnerEmailNotification:   to.Ptr(false),
			},
			IsGracePeriod:      to.Ptr(true),
			Owner:              to.Ptr("user@contoso.com"),
			RemediationDueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-07T13:00:00.000Z"); return t }()),
			RemediationEta: &armsecurity.RemediationEta{
				Eta:           to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T13:00:00.000Z"); return t }()),
				Justification: to.Ptr("Justification of ETA"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GovernanceAssignment = armsecurity.GovernanceAssignment{
	// 	Name: to.Ptr("6634ff9f-127b-4bf2-8e6e-b1737f5e789c"),
	// 	Type: to.Ptr("Microsoft.Security/assessments/governanceAssignments"),
	// 	ID: to.Ptr("/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012/providers/Microsoft.Security/assessments/6b9421dd-5555-2251-9b3d-2be58e2f82cd/governanceAssignments/6634ff9f-127b-4bf2-8e6e-b1737f5e789c"),
	// 	Properties: &armsecurity.GovernanceAssignmentProperties{
	// 		AdditionalData: &armsecurity.GovernanceAssignmentAdditionalData{
	// 			TicketLink: to.Ptr("https://snow.com"),
	// 			TicketNumber: to.Ptr[int32](123123),
	// 			TicketStatus: to.Ptr("Active"),
	// 		},
	// 		GovernanceEmailNotification: &armsecurity.GovernanceEmailNotification{
	// 			DisableManagerEmailNotification: to.Ptr(false),
	// 			DisableOwnerEmailNotification: to.Ptr(false),
	// 		},
	// 		IsGracePeriod: to.Ptr(true),
	// 		Owner: to.Ptr("user@contoso.com"),
	// 		RemediationDueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-07T13:00:00.000Z"); return t}()),
	// 		RemediationEta: &armsecurity.RemediationEta{
	// 			Eta: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T13:00:00.000Z"); return t}()),
	// 			Justification: to.Ptr("Justification of ETA"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a governance assignment on the given subscription.
 *
 * @summary Creates or updates a governance assignment on the given subscription.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceAssignments/PutGovernanceAssignment_example.json
 */
async function createGovernanceAssignment() {
  const scope =
    "subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012";
  const assessmentName = "6b9421dd-5555-2251-9b3d-2be58e2f82cd";
  const assignmentKey = "6634ff9f-127b-4bf2-8e6e-b1737f5e789c";
  const governanceAssignment = {
    additionalData: {
      ticketLink: "https://snow.com",
      ticketNumber: 123123,
      ticketStatus: "Active",
    },
    governanceEmailNotification: {
      disableManagerEmailNotification: false,
      disableOwnerEmailNotification: false,
    },
    isGracePeriod: true,
    owner: "user@contoso.com",
    remediationDueDate: new Date("2022-01-07T13:00:00.0000000Z"),
    remediationEta: {
      eta: new Date("2022-01-08T13:00:00.0000000Z"),
      justification: "Justification of ETA",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.governanceAssignments.createOrUpdate(
    scope,
    assessmentName,
    assignmentKey,
    governanceAssignment,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityCenter.Models;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceAssignments/PutGovernanceAssignment_example.json
// this example is just showing the usage of "GovernanceAssignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this GovernanceAssignmentResource created on azure
// for more information of creating GovernanceAssignmentResource, please refer to the document of GovernanceAssignmentResource
string scope = "subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012";
string assessmentName = "6b9421dd-5555-2251-9b3d-2be58e2f82cd";
string assignmentKey = "6634ff9f-127b-4bf2-8e6e-b1737f5e789c";
ResourceIdentifier governanceAssignmentResourceId = GovernanceAssignmentResource.CreateResourceIdentifier(scope, assessmentName, assignmentKey);
GovernanceAssignmentResource governanceAssignment = client.GetGovernanceAssignmentResource(governanceAssignmentResourceId);

// invoke the operation
GovernanceAssignmentData data = new GovernanceAssignmentData
{
    Owner = "user@contoso.com",
    RemediationDueOn = DateTimeOffset.Parse("2022-01-07T13:00:00.0000000Z"),
    RemediationEta = new RemediationEta(DateTimeOffset.Parse("2022-01-08T13:00:00.0000000Z"), "Justification of ETA"),
    IsGracePeriod = true,
    GovernanceEmailNotification = new GovernanceEmailNotification
    {
        IsManagerEmailNotificationDisabled = false,
        IsOwnerEmailNotificationDisabled = false,
    },
    AdditionalData = new GovernanceAssignmentAdditionalInfo
    {
        TicketNumber = 123123,
        TicketLink = "https://snow.com",
        TicketStatus = "Active",
    },
};
ArmOperation<GovernanceAssignmentResource> lro = await governanceAssignment.UpdateAsync(WaitUntil.Completed, data);
GovernanceAssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
GovernanceAssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012/providers/Microsoft.Security/assessments/6b9421dd-5555-2251-9b3d-2be58e2f82cd/governanceAssignments/6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
  "name": "6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
  "type": "Microsoft.Security/assessments/governanceAssignments",
  "properties": {
    "owner": "user@contoso.com",
    "remediationDueDate": "2022-01-07T13:00:00.0000000Z",
    "remediationEta": {
      "eta": "2022-01-08T13:00:00.0000000Z",
      "justification": "Justification of ETA"
    },
    "isGracePeriod": true,
    "governanceEmailNotification": {
      "disableManagerEmailNotification": false,
      "disableOwnerEmailNotification": false
    },
    "additionalData": {
      "ticketNumber": 123123,
      "ticketLink": "https://snow.com",
      "ticketStatus": "Active"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012/providers/Microsoft.Security/assessments/6b9421dd-5555-2251-9b3d-2be58e2f82cd/governanceAssignments/6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
  "name": "6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
  "type": "Microsoft.Security/assessments/governanceAssignments",
  "properties": {
    "owner": "user@contoso.com",
    "remediationDueDate": "2022-01-07T13:00:00.0000000Z",
    "remediationEta": {
      "eta": "2022-01-08T13:00:00.0000000Z",
      "justification": "Justification of ETA"
    },
    "isGracePeriod": true,
    "governanceEmailNotification": {
      "disableManagerEmailNotification": false,
      "disableOwnerEmailNotification": false
    },
    "additionalData": {
      "ticketNumber": 123123,
      "ticketLink": "https://snow.com",
      "ticketStatus": "Active"
    }
  }
}

Definitions

Name	Description
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
ErrorAdditionalInfo	The resource management error additional info.
GovernanceAssignment	Governance assignment over a given scope
GovernanceAssignmentAdditionalData	Describe the additional data of governance assignment - optional
GovernanceEmailNotification	The governance email weekly notification configuration.
RemediationEta	The ETA (estimated time of arrival) for remediation

CloudError

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

GovernanceAssignment

Object

Governance assignment over a given scope

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.additionalData	GovernanceAssignmentAdditionalData	The additional data for the governance assignment - e.g. links to ticket (optional), see example
properties.governanceEmailNotification	GovernanceEmailNotification	The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners
properties.isGracePeriod	boolean	Defines whether there is a grace period on the governance assignment
properties.owner	string	The Owner for the governance assignment - e.g. user@contoso.com - see example
properties.remediationDueDate	string (date-time)	The remediation due-date - after this date Secure Score will be affected (in case of active grace-period)
properties.remediationEta	RemediationEta	The ETA (estimated time of arrival) for remediation (optional), see example
type	string	Resource type

GovernanceAssignmentAdditionalData

Object

Describe the additional data of governance assignment - optional

Name	Type	Description
ticketLink	string	Ticket link associated with this governance assignment - for example: https://snow.com
ticketNumber	integer (int32) minimum: 0	Ticket number associated with this governance assignment
ticketStatus	string	The ticket status associated with this governance assignment - for example: Active

GovernanceEmailNotification

Object

The governance email weekly notification configuration.

Name	Type	Description
disableManagerEmailNotification	boolean	Exclude manager from weekly email notification.
disableOwnerEmailNotification	boolean	Exclude owner from weekly email notification.

RemediationEta

Object

The ETA (estimated time of arrival) for remediation

Name	Type	Description
eta	string (date-time)	ETA for remediation.
justification	string	Justification for change of Eta.