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	OK - 更新済み
201 Created	GovernanceAssignment	作成
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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 Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
CloudErrorBody	エラーの詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
GovernanceAssignment	特定のスコープに対するガバナンスの割り当て
GovernanceAssignmentAdditionalData	ガバナンス割り当ての追加データについて説明する - 省略可能
GovernanceEmailNotification	ガバナンス電子メールの週単位の通知構成。
RemediationEta	修復のための ETA (推定到着時間)

CloudError

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager 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 の変更の正当な理由。