你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
assessmentName	path	True	string	评估密钥 - 评估类型的唯一密钥 正则表达式模式: ^[-\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 版本

请求正文

名称	必需	类型	说明
properties.remediationDueDate	True	string	修正截止日期 - 在此日期之后，安全功能分数将受到影响（如果有效宽限期）
properties.additionalData		GovernanceAssignmentAdditionalData	治理分配的其他数据-例如票证链接（可选），请参阅示例
properties.governanceEmailNotification		GovernanceEmailNotification	治理规则的电子邮件通知设置，指示是否禁用管理者和所有者的通知
properties.isGracePeriod		boolean	定义治理分配是否有宽限期
properties.owner		string	治理分配的所有者（例如 user@contoso.com）请参阅示例
properties.remediationEta		RemediationEta	修正的 ETA（预计到达时间）（可选），请参阅示例

响应

名称	类型	说明
200 OK	GovernanceAssignment	确定 - 已更新
201 Created	GovernanceAssignment	创建
Other Status Codes	CloudError	描述操作失败原因的错误响应

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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"
    }
  }
}

定义

名称	说明
CloudError	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。 （这也遵循 OData 错误响应格式）。
CloudErrorBody	错误详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
GovernanceAssignment	给定范围的治理分配
GovernanceAssignmentAdditionalData	描述治理分配的其他数据 - 可选
GovernanceEmailNotification	治理电子邮件每周通知配置。
RemediationEta	修正的 ETA （预计到达时间）

CloudError

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。 （这也遵循 OData 错误响应格式）。

名称	类型	说明
error.additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
error.code	string	错误代码。
error.details	CloudErrorBody[]	错误详细信息。
error.message	string	错误消息。
error.target	string	错误目标。

CloudErrorBody

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	CloudErrorBody[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

GovernanceAssignment

给定范围的治理分配

名称	类型	说明
id	string	资源 ID
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

描述治理分配的其他数据 - 可选

名称	类型	说明
ticketLink	string	与此治理分配关联的票证链接 - 例如：https://snow.com
ticketNumber	integer	与此治理分配关联的票证编号
ticketStatus	string	与此治理分配关联的票证状态 - 例如：活动

GovernanceEmailNotification

治理电子邮件每周通知配置。

名称	类型	说明
disableManagerEmailNotification	boolean	从每周电子邮件通知中排除经理。
disableOwnerEmailNotification	boolean	从每周电子邮件通知中排除所有者。

RemediationEta

修正的 ETA （预计到达时间）

名称	类型	说明
eta	string	用于修正的 ETA。
justification	string	更改 Eta 的理由。