Governance Assignments - Create Or Update

Serviço:

Defender for Cloud

Versão da API:

2022-01-01-preview

Cria ou atualiza uma atribuição de governança na assinatura fornecida.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
assessmentName	path	True	string pattern: ^[-\w\._\(\)]+$	A chave de avaliação da tarefa de governança.
assignmentKey	path	True	string	A chave de atribuição de governança.
scope	path	True	string	O escopo da tarefa de governança.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.remediationDueDate	True	string (date-time)	A data de conclusão da correção – após essa data, a Pontuação Segura será afetada (em caso de período de carência ativo)
properties.additionalData		GovernanceAssignmentAdditionalData	Os dados adicionais para a atribuição de governança - por exemplo, links para tíquete (opcional), confira o exemplo
properties.governanceEmailNotification		GovernanceEmailNotification	As configurações de notificações por email para a regra de governança determinam se as notificações devem ser desabilitados para mangers e proprietários
properties.isGracePeriod		boolean	Define se há um período de carência na atribuição de governança
properties.owner		string	O Proprietário da atribuição de governança - por exemplo, user@contoso.com - confira o exemplo
properties.remediationEta		RemediationEta	O ETA (tempo estimado de chegada) para correção (opcional), confira o exemplo

Respostas

Nome	Tipo	Description
200 OK	GovernanceAssignment	Operação de atualização do recurso 'GovernanceAssignment' bem-sucedida
201 Created	GovernanceAssignment	Recurso 'GovernanceAssignment' criar operação bem-sucedida
Other Status Codes	Common.CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create Governance assignment

Solicitação de exemplo

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

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: 2022-01-01-preview/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("<subscriptionID>", 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.0000000Z"); return t }()),
			RemediationEta: &armsecurity.RemediationEta{
				Eta:           to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T13:00:00.0000000Z"); 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 = armsecurity.GovernanceAssignmentsClientCreateOrUpdateResponse{
	// 	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.0000000Z"); return t}()),
	// 			RemediationEta: &armsecurity.RemediationEta{
	// 				Eta: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T13:00:00.0000000Z"); 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: 2022-01-01-preview/GovernanceAssignments/PutGovernanceAssignment_example.json
 */
async function createGovernanceAssignment() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.governanceAssignments.createOrUpdate(
    "subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/resourceGroups/compute_servers/providers/Microsoft.Compute/virtualMachines/win2012",
    "6b9421dd-5555-2251-9b3d-2be58e2f82cd",
    "6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
    {
      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",
      },
    },
  );
  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

Resposta de exemplo

Código de status:

200

{
  "name": "6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
  "type": "Microsoft.Security/assessments/governanceAssignments",
  "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",
  "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"
    }
  }
}

Código de status:

201

{
  "name": "6634ff9f-127b-4bf2-8e6e-b1737f5e789c",
  "type": "Microsoft.Security/assessments/governanceAssignments",
  "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",
  "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"
    }
  }
}

Definições

Nome	Description
Common.CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
Common.CloudErrorBody	O detalhe do erro.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
GovernanceAssignment	Atribuição de governança em um determinado escopo
GovernanceAssignmentAdditionalData	Descrever os dados adicionais da atribuição de governança – opcional
GovernanceEmailNotification	A configuração de notificação semanal por email de governança.
RemediationEta	O ETA (tempo estimado de chegada) para correção
systemData	Metadados relativos à criação e última modificação do recurso.

Common.CloudError

Objeto

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	Common.CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

Common.CloudErrorBody

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	Common.CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

GovernanceAssignment

Objeto

Atribuição de governança em um determinado escopo

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.additionalData	GovernanceAssignmentAdditionalData	Os dados adicionais para a atribuição de governança - por exemplo, links para tíquete (opcional), confira o exemplo
properties.governanceEmailNotification	GovernanceEmailNotification	As configurações de notificações por email para a regra de governança determinam se as notificações devem ser desabilitados para mangers e proprietários
properties.isGracePeriod	boolean	Define se há um período de carência na atribuição de governança
properties.owner	string	O Proprietário da atribuição de governança - por exemplo, user@contoso.com - confira o exemplo
properties.remediationDueDate	string (date-time)	A data de conclusão da correção – após essa data, a Pontuação Segura será afetada (em caso de período de carência ativo)
properties.remediationEta	RemediationEta	O ETA (tempo estimado de chegada) para correção (opcional), confira o exemplo
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

GovernanceAssignmentAdditionalData

Objeto

Descrever os dados adicionais da atribuição de governança – opcional

Nome	Tipo	Description
ticketLink	string	Link de tíquete associado a essa atribuição de governança – por exemplo: https://snow.com
ticketNumber	integer (int32) minimum: 0	Número do tíquete associado a essa atribuição de governança
ticketStatus	string	O status do tíquete associado a essa atribuição de governança - por exemplo: Ativo

GovernanceEmailNotification

Objeto

A configuração de notificação semanal por email de governança.

Nome	Tipo	Description
disableManagerEmailNotification	boolean	Exclua o gerente da notificação por email semanal.
disableOwnerEmailNotification	boolean	Exclua o proprietário da notificação por email semanal.

RemediationEta

Objeto

O ETA (tempo estimado de chegada) para correção

Nome	Tipo	Description
eta	string (date-time)	ETA para correção.
justification	string	Justificativa para a alteração do Eta.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.