Governance Assignments - Create Or Update

服務:

Defender for Cloud

API 版本:

2022-01-01-preview

在指定的訂用帳戶上建立或更新治理指派。

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

URI 參數

名稱	位於	必要	類型	Description
assessmentName	path	True	string	評定金鑰 - 評量類型的唯一索引鍵 Regex 模式: ^[-\w\._\(\)]+$
assignmentKey	path	True	string	治理指派金鑰 - 必要治理指派的評估金鑰
scope	path	True	string	治理指派的範圍。 有效範圍包括：訂用帳戶（格式：'subscriptions/{subscriptionId}'），或安全性連接器（格式：'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}）'
api-version	query	True	string	作業的 API 版本

要求本文

名稱	必要	類型	Description
properties.remediationDueDate	True	string	補救到期日 - 在此日期之後，安全分數將受到影響（如果是使用中的寬限期）
properties.additionalData		GovernanceAssignmentAdditionalData	治理指派的其他數據 ，例如票證的連結（選擇性），請參閱範例
properties.governanceEmailNotification		GovernanceEmailNotification	治理規則的電子郵件通知設定，指出是否要停用管理員和擁有者的通知
properties.isGracePeriod		boolean	定義治理指派是否有寬限期
properties.owner		string	治理指派的擁有者 - 例如 user@contoso.com - 請參閱範例
properties.remediationEta		RemediationEta	補救的 ETA （估計抵達時間）（選擇性），請參閱範例

回應

名稱	類型	Description
200 OK	GovernanceAssignment	確定 - 已更新
201 Created	GovernanceAssignment	創建
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create Governance assignment

範例要求

HTTP

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"
    }
  }
}

Java

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

Go

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

JavaScript

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

dotnet

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

// 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

範例回覆

狀態碼:

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"
    }
  }
}

狀態碼:

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"
    }
  }
}

定義

名稱	Description
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
GovernanceAssignment	指定範圍的治理指派
GovernanceAssignmentAdditionalData	描述治理指派的其他數據 - 選擇性
GovernanceEmailNotification	治理電子郵件每周通知設定。
RemediationEta	用於補救的 ETA （估計抵達時間 ）

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細數據。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

GovernanceAssignment

指定範圍的治理指派

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.additionalData	GovernanceAssignmentAdditionalData	治理指派的其他數據 ，例如票證的連結（選擇性），請參閱範例
properties.governanceEmailNotification	GovernanceEmailNotification	治理規則的電子郵件通知設定，指出是否要停用管理員和擁有者的通知
properties.isGracePeriod	boolean	定義治理指派是否有寬限期
properties.owner	string	治理指派的擁有者 - 例如 user@contoso.com - 請參閱範例
properties.remediationDueDate	string	補救到期日 - 在此日期之後，安全分數將受到影響（如果是使用中的寬限期）
properties.remediationEta	RemediationEta	補救的 ETA （估計抵達時間）（選擇性），請參閱範例
type	string	資源類型

GovernanceAssignmentAdditionalData

描述治理指派的其他數據 - 選擇性

名稱	類型	Description
ticketLink	string	與此治理指派相關聯的票證連結 - 例如：https://snow.com
ticketNumber	integer	與此治理指派相關聯的票證號碼
ticketStatus	string	與此治理指派相關聯的票證狀態 - 例如：作用中

GovernanceEmailNotification

治理電子郵件每周通知設定。

名稱	類型	Description
disableManagerEmailNotification	boolean	從每周電子郵件通知中排除管理員。
disableOwnerEmailNotification	boolean	排除每周電子郵件通知的擁有者。

RemediationEta

用於補救的 ETA （估計抵達時間 ）

名稱	類型	Description
eta	string	用於補救的ETA。
justification	string	變更 Eta 的理由。