Information Protection Policies - Create Or Update

Referens

Tjänst:: Defender for Cloud

API-version:: 2017-08-01-preview

Information om informationsskyddsprincipen.

PUT https://management.azure.com/{scope}/providers/Microsoft.Security/informationProtectionPolicies/{informationProtectionPolicyName}?api-version=2017-08-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
informationProtectionPolicyName	path	True	InformationProtectionPolicyName	Namnet på informationsskyddsprincipen.
scope	path	True	string	Frågans omfattning kan vara prenumeration (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) eller hanteringsgrupp (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	API-version för åtgärden

Begärandetext

Name	Typ	Description
properties.informationTypes	<string, InformationType>	Typer av känslighetsinformation.
properties.labels	<string, SensitivityLabel>	Ordlista med känslighetsetiketter.

Svar

Name	Typ	Description
200 OK	InformationProtectionPolicy	OKEJ
201 Created	InformationProtectionPolicy	Skapad
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create or update an information protection policy for a management group

Exempelbegäran

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom?api-version=2017-08-01-preview

{
  "properties": {
    "labels": {
      "1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
        "displayName": "Public",
        "order": 100,
        "enabled": true
      },
      "7aa516c7-5a53-4857-bc6e-6808c6acd542": {
        "displayName": "General",
        "order": 200,
        "enabled": true
      },
      "575739d2-3d53-4df0-9042-4c7772d5c7b1": {
        "displayName": "Confidential",
        "order": 300,
        "enabled": true
      }
    },
    "informationTypes": {
      "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
        "displayName": "Networking",
        "order": 100,
        "recommendedLabelId": "575739d2-3d53-4df0-9042-4c7772d5c7b1",
        "enabled": true,
        "custom": false,
        "keywords": [
          {
            "pattern": "%networking%",
            "custom": true,
            "canBeNumeric": false
          }
        ]
      },
      "3bf35491-99b8-41f2-86d5-c1200a7df658": {
        "displayName": "Custom",
        "order": 1400,
        "recommendedLabelId": "7aa516c7-5a53-4857-bc6e-6808c6acd542",
        "enabled": true,
        "custom": true,
        "keywords": [
          {
            "pattern": "%custom%",
            "custom": true,
            "canBeNumeric": true
          }
        ]
      }
    }
  }
}


import com.azure.resourcemanager.security.models.InformationProtectionKeyword;
import com.azure.resourcemanager.security.models.InformationProtectionPolicyName;
import com.azure.resourcemanager.security.models.InformationType;
import com.azure.resourcemanager.security.models.SensitivityLabel;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * Samples for InformationProtectionPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/
     * InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json
     */
    /**
     * Sample code: Create or update an information protection policy for a management group.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateAnInformationProtectionPolicyForAManagementGroup(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.informationProtectionPolicies().define(InformationProtectionPolicyName.CUSTOM)
            .withExistingScope("providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e")
            .withLabels(
                mapOf("1345da73-bc5a-4a8f-b7dd-3820eb713da8",
                    new SensitivityLabel().withDisplayName("Public").withOrder(100).withEnabled(true),
                    "575739d2-3d53-4df0-9042-4c7772d5c7b1",
                    new SensitivityLabel().withDisplayName("Confidential").withOrder(300).withEnabled(true),
                    "7aa516c7-5a53-4857-bc6e-6808c6acd542", new SensitivityLabel().withDisplayName("General")
                        .withOrder(200).withEnabled(true)))
            .withInformationTypes(mapOf("3bf35491-99b8-41f2-86d5-c1200a7df658",
                new InformationType().withDisplayName("Custom").withOrder(1400)
                    .withRecommendedLabelId(UUID.fromString("7aa516c7-5a53-4857-bc6e-6808c6acd542")).withEnabled(true)
                    .withCustom(true)
                    .withKeywords(Arrays.asList(new InformationProtectionKeyword()
                        .withPattern("%custom%").withCustom(true).withCanBeNumeric(true))),
                "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07",
                new InformationType().withDisplayName("Networking").withOrder(100)
                    .withRecommendedLabelId(UUID.fromString("575739d2-3d53-4df0-9042-4c7772d5c7b1")).withEnabled(true)
                    .withCustom(false).withKeywords(Arrays.asList(new InformationProtectionKeyword()
                        .withPattern("%networking%").withCustom(true).withCanBeNumeric(false)))))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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"

	"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/2017-08-01-preview/examples/InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json
func ExampleInformationProtectionPoliciesClient_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.NewInformationProtectionPoliciesClient().CreateOrUpdate(ctx, "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e", armsecurity.InformationProtectionPolicyNameCustom, armsecurity.InformationProtectionPolicy{
		Properties: &armsecurity.InformationProtectionPolicyProperties{
			InformationTypes: map[string]*armsecurity.InformationType{
				"3bf35491-99b8-41f2-86d5-c1200a7df658": {
					Custom:      to.Ptr(true),
					DisplayName: to.Ptr("Custom"),
					Enabled:     to.Ptr(true),
					Keywords: []*armsecurity.InformationProtectionKeyword{
						{
							CanBeNumeric: to.Ptr(true),
							Custom:       to.Ptr(true),
							Pattern:      to.Ptr("%custom%"),
						}},
					Order:              to.Ptr[int32](1400),
					RecommendedLabelID: to.Ptr("7aa516c7-5a53-4857-bc6e-6808c6acd542"),
				},
				"7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
					Custom:      to.Ptr(false),
					DisplayName: to.Ptr("Networking"),
					Enabled:     to.Ptr(true),
					Keywords: []*armsecurity.InformationProtectionKeyword{
						{
							CanBeNumeric: to.Ptr(false),
							Custom:       to.Ptr(true),
							Pattern:      to.Ptr("%networking%"),
						}},
					Order:              to.Ptr[int32](100),
					RecommendedLabelID: to.Ptr("575739d2-3d53-4df0-9042-4c7772d5c7b1"),
				},
			},
			Labels: map[string]*armsecurity.SensitivityLabel{
				"1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
					DisplayName: to.Ptr("Public"),
					Enabled:     to.Ptr(true),
					Order:       to.Ptr[int32](100),
				},
				"575739d2-3d53-4df0-9042-4c7772d5c7b1": {
					DisplayName: to.Ptr("Confidential"),
					Enabled:     to.Ptr(true),
					Order:       to.Ptr[int32](300),
				},
				"7aa516c7-5a53-4857-bc6e-6808c6acd542": {
					DisplayName: to.Ptr("General"),
					Enabled:     to.Ptr(true),
					Order:       to.Ptr[int32](200),
				},
			},
		},
	}, 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.InformationProtectionPolicy = armsecurity.InformationProtectionPolicy{
	// 	Name: to.Ptr("custom"),
	// 	Type: to.Ptr("Microsoft.Security/informationProtectionPolicies"),
	// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom"),
	// 	Properties: &armsecurity.InformationProtectionPolicyProperties{
	// 		InformationTypes: map[string]*armsecurity.InformationType{
	// 			"3bf35491-99b8-41f2-86d5-c1200a7df658": &armsecurity.InformationType{
	// 				Custom: to.Ptr(true),
	// 				DisplayName: to.Ptr("Custom"),
	// 				Enabled: to.Ptr(true),
	// 				Keywords: []*armsecurity.InformationProtectionKeyword{
	// 					{
	// 						CanBeNumeric: to.Ptr(true),
	// 						Custom: to.Ptr(true),
	// 						Pattern: to.Ptr("%custom%"),
	// 				}},
	// 				Order: to.Ptr[int32](1400),
	// 				RecommendedLabelID: to.Ptr("7aa516c7-5a53-4857-bc6e-6808c6acd542"),
	// 			},
	// 			"7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": &armsecurity.InformationType{
	// 				Custom: to.Ptr(false),
	// 				DisplayName: to.Ptr("Networking"),
	// 				Enabled: to.Ptr(true),
	// 				Keywords: []*armsecurity.InformationProtectionKeyword{
	// 					{
	// 						CanBeNumeric: to.Ptr(false),
	// 						Custom: to.Ptr(true),
	// 						Pattern: to.Ptr("%networking%"),
	// 				}},
	// 				Order: to.Ptr[int32](100),
	// 				RecommendedLabelID: to.Ptr("575739d2-3d53-4df0-9042-4c7772d5c7b1"),
	// 			},
	// 		},
	// 		Labels: map[string]*armsecurity.SensitivityLabel{
	// 			"1345da73-bc5a-4a8f-b7dd-3820eb713da8": &armsecurity.SensitivityLabel{
	// 				DisplayName: to.Ptr("Public"),
	// 				Enabled: to.Ptr(true),
	// 				Order: to.Ptr[int32](100),
	// 			},
	// 			"575739d2-3d53-4df0-9042-4c7772d5c7b1": &armsecurity.SensitivityLabel{
	// 				DisplayName: to.Ptr("Confidential"),
	// 				Enabled: to.Ptr(true),
	// 				Order: to.Ptr[int32](300),
	// 			},
	// 			"7aa516c7-5a53-4857-bc6e-6808c6acd542": &armsecurity.SensitivityLabel{
	// 				DisplayName: to.Ptr("General"),
	// 				Enabled: to.Ptr(true),
	// 				Order: to.Ptr[int32](200),
	// 			},
	// 		},
	// 	},
	// }
}

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 Details of the information protection policy.
 *
 * @summary Details of the information protection policy.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json
 */
async function createOrUpdateAnInformationProtectionPolicyForAManagementGroup() {
  const scope =
    "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e";
  const informationProtectionPolicyName = "custom";
  const informationProtectionPolicy = {
    informationTypes: {
      "3bf3549199b841f286d5C1200a7df658": {
        custom: true,
        displayName: "Custom",
        enabled: true,
        keywords: [{ canBeNumeric: true, custom: true, pattern: "%custom%" }],
        order: 1400,
        recommendedLabelId: "7aa516c7-5a53-4857-bc6e-6808c6acd542",
      },
      "7fb9419d24734ad88e11B25cc8cf6a07": {
        custom: false,
        displayName: "Networking",
        enabled: true,
        keywords: [{ canBeNumeric: false, custom: true, pattern: "%networking%" }],
        order: 100,
        recommendedLabelId: "575739d2-3d53-4df0-9042-4c7772d5c7b1",
      },
    },
    labels: {
      "1345da73Bc5a4a8fB7dd3820eb713da8": {
        displayName: "Public",
        enabled: true,
        order: 100,
      },
      "575739d23d534df090424c7772d5c7b1": {
        displayName: "Confidential",
        enabled: true,
        order: 300,
      },
      "7aa516c75a534857Bc6e6808c6acd542": {
        displayName: "General",
        enabled: true,
        order: 200,
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.informationProtectionPolicies.createOrUpdate(
    scope,
    informationProtectionPolicyName,
    informationProtectionPolicy,
  );
  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

Exempelsvar

Statuskod:: 200

{
  "id": "/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom",
  "name": "custom",
  "type": "Microsoft.Security/informationProtectionPolicies",
  "properties": {
    "labels": {
      "1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
        "displayName": "Public",
        "order": 100,
        "enabled": true
      },
      "7aa516c7-5a53-4857-bc6e-6808c6acd542": {
        "displayName": "General",
        "order": 200,
        "enabled": true
      },
      "575739d2-3d53-4df0-9042-4c7772d5c7b1": {
        "displayName": "Confidential",
        "order": 300,
        "enabled": true
      }
    },
    "informationTypes": {
      "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
        "displayName": "Networking",
        "order": 100,
        "recommendedLabelId": "575739d2-3d53-4df0-9042-4c7772d5c7b1",
        "enabled": true,
        "custom": false,
        "keywords": [
          {
            "pattern": "%networking%",
            "custom": true,
            "canBeNumeric": false
          }
        ]
      },
      "3bf35491-99b8-41f2-86d5-c1200a7df658": {
        "displayName": "Custom",
        "order": 1400,
        "recommendedLabelId": "7aa516c7-5a53-4857-bc6e-6808c6acd542",
        "enabled": true,
        "custom": true,
        "keywords": [
          {
            "pattern": "%custom%",
            "custom": true,
            "canBeNumeric": true
          }
        ]
      }
    }
  }
}

Statuskod:: 201

{
  "id": "/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom",
  "name": "custom",
  "type": "Microsoft.Security/informationProtectionPolicies",
  "properties": {
    "labels": {
      "1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
        "displayName": "Public",
        "order": 100,
        "enabled": true
      },
      "7aa516c7-5a53-4857-bc6e-6808c6acd542": {
        "displayName": "General",
        "order": 200,
        "enabled": true
      },
      "575739d2-3d53-4df0-9042-4c7772d5c7b1": {
        "displayName": "Confidential",
        "order": 300,
        "enabled": true
      }
    },
    "informationTypes": {
      "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
        "displayName": "Networking",
        "order": 100,
        "recommendedLabelId": "575739d2-3d53-4df0-9042-4c7772d5c7b1",
        "enabled": true,
        "custom": false,
        "keywords": [
          {
            "pattern": "%networking%",
            "custom": true,
            "canBeNumeric": false
          }
        ]
      },
      "3bf35491-99b8-41f2-86d5-c1200a7df658": {
        "displayName": "Custom",
        "order": 1400,
        "recommendedLabelId": "7aa516c7-5a53-4857-bc6e-6808c6acd542",
        "enabled": true,
        "custom": true,
        "keywords": [
          {
            "pattern": "%custom%",
            "custom": true,
            "canBeNumeric": true
          }
        ]
      }
    }
  }
}

Definitioner

Name	Description
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
InformationProtectionKeyword	Nyckelordet informationstyp.
InformationProtectionPolicy	Informationsskyddsprincip.
InformationProtectionPolicyName	Namnet på informationsskyddsprincipen.
InformationType	Informationstypen.
rank	Känslighetsetikettens rangordning.
SensitivityLabel	Känslighetsetiketten.

CloudError

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

InformationProtectionKeyword

Objekt

Nyckelordet informationstyp.

Name	Typ	Description
canBeNumeric	boolean	Anger om nyckelordet kan tillämpas på numeriska typer eller inte.
custom	boolean	Anger om nyckelordet är anpassat eller inte.
excluded	boolean	Anger om nyckelordet är exkluderat eller inte.
pattern	string	Nyckelordsmönstret.

InformationProtectionPolicy

Objekt

Informationsskyddsprincip.

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties.informationTypes	<string, InformationType>	Typer av känslighetsinformation.
properties.labels	<string, SensitivityLabel>	Ordlista med känslighetsetiketter.
properties.lastModifiedUtc	string (date-time)	Beskriver den senaste UTC-tiden då principen ändrades.
properties.version	string	Beskriver versionen av principen.
type	string	Resurstyp

InformationProtectionPolicyName

Uppräkning

Namnet på informationsskyddsprincipen.

Värde	Description
custom
effective

InformationType

Objekt

Informationstypen.

Name	Typ	Description
custom	boolean	Anger om informationstypen är anpassad eller inte.
description	string	Beskrivningen av informationstypen.
displayName	string	Namnet på informationstypen.
enabled	boolean	Anger om informationstypen är aktiverad eller inte.
keywords	InformationProtectionKeyword[]	Nyckelord för informationstyp.
order	integer (int32)	Ordningen på informationstypen.
recommendedLabelId	string (uuid)	Det rekommenderade etikett-ID som ska associeras med den här informationstypen.

rank

Uppräkning

Känslighetsetikettens rangordning.

Värde	Description
Critical
High
Low
Medium
None

SensitivityLabel

Objekt

Känslighetsetiketten.

Name	Typ	Description
description	string	Beskrivningen av känslighetsetiketten.
displayName	string	Namnet på känslighetsetiketten.
enabled	boolean	Anger om etiketten är aktiverad eller inte.
order	integer (int32)	Känslighetsetikettens ordning.
rank	rank	Känslighetsetikettens rangordning.

Dela via

Information Protection Policies - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create or update an information protection policy for a management group

Exempelbegäran

Exempelsvar

Definitioner

CloudError

CloudErrorBody

ErrorAdditionalInfo

InformationProtectionKeyword

InformationProtectionPolicy

InformationProtectionPolicyName

InformationType

rank

SensitivityLabel

Ytterligare resurser