Create updatePolicy

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new updatePolicy object.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	WindowsUpdates.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	WindowsUpdates.ReadWrite.All

HTTP request

POST /admin/windows/updates/updatePolicies

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the updatePolicy object.

You can specify the following properties when you create an updatePolicy.

Property	Type	Description
audience	microsoft.graph.windowsUpdates.deploymentAudience	Specifies the audience to target.
complianceChanges	microsoft.graph.windowsUpdates.complianceChange collection	Compliance changes like content approvals which result in the automatic creation of deployments using the audience and deploymentSettings of the policy.
complianceChangeRules	microsoft.graph.windowsUpdates.complianceChangeRule collection	Rules for governing the automatic creation of compliance changes.
deploymentSettings	microsoft.graph.windowsUpdates.deploymentSettings	Settings for governing how to deploy content.

Response

If successful, this method returns a 201 Created response code and an microsoft.graph.windowsUpdates.updatePolicy object in the response body.

Examples

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/beta/admin/windows/updates/updatePolicies
Content-Type: application/json
Content-length: 835

{
  "@odata.type": "#microsoft.graph.windowsUpdates.updatePolicy",
  "audience": {
    "id": "8c4eb1eb-d7a3-4633-8e2f-f926e82df08e"
  },
  "complianceChanges": [
    {
      "@odata.type": "#microsoft.graph.windowsUpdates.contentApproval"
    }
  ],
  "complianceChangeRules": [
    {
      "@odata.type": "#microsoft.graph.windowsUpdates.contentApprovalRule",
      "contentFilter": {
        "@odata.type": "#microsoft.graph.windowsUpdates.driverUpdateFilter"
      },
      "durationBeforeDeploymentStart": "P7D"
    }
  ],
  "deploymentSettings": {
    "@odata.type": "microsoft.graph.windowsUpdates.deploymentSettings",
    "schedule": {
      "gradualRollout": {
        "@odata.type": "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings",
        "durationBetweenOffers": "P1D",
        "devicePerOffer": 1000
      }
    }
  }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Models.WindowsUpdates.UpdatePolicy
{
	OdataType = "#microsoft.graph.windowsUpdates.updatePolicy",
	Audience = new Microsoft.Graph.Beta.Models.WindowsUpdates.DeploymentAudience
	{
		Id = "8c4eb1eb-d7a3-4633-8e2f-f926e82df08e",
	},
	ComplianceChanges = new List<Microsoft.Graph.Beta.Models.WindowsUpdates.ComplianceChange>
	{
		new Microsoft.Graph.Beta.Models.WindowsUpdates.ComplianceChange
		{
			OdataType = "#microsoft.graph.windowsUpdates.contentApproval",
		},
	},
	ComplianceChangeRules = new List<Microsoft.Graph.Beta.Models.WindowsUpdates.ComplianceChangeRule>
	{
		new Microsoft.Graph.Beta.Models.WindowsUpdates.ComplianceChangeRule
		{
			OdataType = "#microsoft.graph.windowsUpdates.contentApprovalRule",
			AdditionalData = new Dictionary<string, object>
			{
				{
					"contentFilter" , new 
					{
						OdataType = "#microsoft.graph.windowsUpdates.driverUpdateFilter",
					}
				},
				{
					"durationBeforeDeploymentStart" , "P7D"
				},
			},
		},
	},
	DeploymentSettings = new Microsoft.Graph.Beta.Models.WindowsUpdates.DeploymentSettings
	{
		OdataType = "microsoft.graph.windowsUpdates.deploymentSettings",
		Schedule = new Microsoft.Graph.Beta.Models.WindowsUpdates.ScheduleSettings
		{
			GradualRollout = new Microsoft.Graph.Beta.Models.WindowsUpdates.GradualRolloutSettings
			{
				OdataType = "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings",
				DurationBetweenOffers = TimeSpan.Parse("P1D"),
				AdditionalData = new Dictionary<string, object>
				{
					{
						"devicePerOffer" , 1000
					},
				},
			},
		},
	},
};
var result = await graphClient.Admin.Windows.Updates.UpdatePolicies.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models//windowsUpdates"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewUpdatePolicy()
audience := graphmodels.NewDeploymentAudience()
id := "8c4eb1eb-d7a3-4633-8e2f-f926e82df08e"
audience.SetId(&id) 
requestBody.SetAudience(audience)


complianceChange := graphmodels.NewComplianceChange()

complianceChanges := []graphmodels.ComplianceChangeable {
	complianceChange,

}
requestBody.SetComplianceChanges(complianceChanges)


complianceChangeRule := graphmodels.NewComplianceChangeRule()
additionalData := map[string]interface{}{
contentFilter := graphmodels.New()
	complianceChangeRule.SetContentFilter(contentFilter)
	"durationBeforeDeploymentStart" : "P7D", 
}
complianceChangeRule.SetAdditionalData(additionalData)

complianceChangeRules := []graphmodels.ComplianceChangeRuleable {
	complianceChangeRule,

}
requestBody.SetComplianceChangeRules(complianceChangeRules)
deploymentSettings := graphmodels.NewDeploymentSettings()
schedule := graphmodels.NewScheduleSettings()
gradualRollout := graphmodels.NewGradualRolloutSettings()
durationBetweenOffers , err := abstractions.ParseISODuration("P1D")
gradualRollout.SetDurationBetweenOffers(&durationBetweenOffers) 
additionalData := map[string]interface{}{
	"devicePerOffer" : int32(1000) , 
}
gradualRollout.SetAdditionalData(additionalData)
schedule.SetGradualRollout(gradualRollout)
deploymentSettings.SetSchedule(schedule)
requestBody.SetDeploymentSettings(deploymentSettings)

result, err := graphClient.Admin().Windows().Updates().UpdatePolicies().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

UpdatePolicy updatePolicy = new UpdatePolicy();
DeploymentAudience audience = new DeploymentAudience();
audience.id = "8c4eb1eb-d7a3-4633-8e2f-f926e82df08e";
updatePolicy.audience = audience;
LinkedList<ComplianceChange> complianceChangesList = new LinkedList<ComplianceChange>();
ContentApproval complianceChanges = new ContentApproval();
complianceChangesList.add(complianceChanges);
ComplianceChangeCollectionResponse complianceChangeCollectionResponse = new ComplianceChangeCollectionResponse();
complianceChangeCollectionResponse.value = complianceChangesList;
ComplianceChangeCollectionPage complianceChangeCollectionPage = new ComplianceChangeCollectionPage(complianceChangeCollectionResponse, null);
updatePolicy.complianceChanges = complianceChangeCollectionPage;
LinkedList<ComplianceChangeRule> complianceChangeRulesList = new LinkedList<ComplianceChangeRule>();
ContentApprovalRule complianceChangeRules = new ContentApprovalRule();
DriverUpdateFilter contentFilter = new DriverUpdateFilter();
complianceChangeRules.contentFilter = contentFilter;
complianceChangeRules.durationBeforeDeploymentStart = DatatypeFactory.newInstance().newDuration("P7D");
complianceChangeRulesList.add(complianceChangeRules);
updatePolicy.complianceChangeRules = complianceChangeRulesList;
DeploymentSettings deploymentSettings = new DeploymentSettings();
ScheduleSettings schedule = new ScheduleSettings();
RateDrivenRolloutSettings gradualRollout = new RateDrivenRolloutSettings();
gradualRollout.durationBetweenOffers = DatatypeFactory.newInstance().newDuration("P1D");
gradualRollout.devicePerOffer = 1000;
schedule.gradualRollout = gradualRollout;
deploymentSettings.schedule = schedule;
updatePolicy.deploymentSettings = deploymentSettings;

graphClient.admin().windows().updates().updatePolicies()
	.buildRequest()
	.post(updatePolicy);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const updatePolicy = {
  '@odata.type': '#microsoft.graph.windowsUpdates.updatePolicy',
  audience: {
    id: '8c4eb1eb-d7a3-4633-8e2f-f926e82df08e'
  },
  complianceChanges: [
    {
      '@odata.type': '#microsoft.graph.windowsUpdates.contentApproval'
    }
  ],
  complianceChangeRules: [
    {
      '@odata.type': '#microsoft.graph.windowsUpdates.contentApprovalRule',
      contentFilter: {
        '@odata.type': '#microsoft.graph.windowsUpdates.driverUpdateFilter'
      },
      durationBeforeDeploymentStart: 'P7D'
    }
  ],
  deploymentSettings: {
    '@odata.type': 'microsoft.graph.windowsUpdates.deploymentSettings',
    schedule: {
      gradualRollout: {
        '@odata.type': '#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings',
        durationBetweenOffers: 'P1D',
        devicePerOffer: 1000
      }
    }
  }
};

await client.api('/admin/windows/updates/updatePolicies')
	.version('beta')
	.post(updatePolicy);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new UpdatePolicy();
$requestBody->set@odatatype('#microsoft.graph.windowsUpdates.updatePolicy');

$audience = new DeploymentAudience();
$audience->setId('8c4eb1eb-d7a3-4633-8e2f-f926e82df08e');


$requestBody->setAudience($audience);
$complianceChangesComplianceChange1 = new ComplianceChange();
$complianceChangesComplianceChange1->set@odatatype('#microsoft.graph.windowsUpdates.contentApproval');


$complianceChangesArray []= $complianceChangesComplianceChange1;
$requestBody->setComplianceChanges($complianceChangesArray);


$complianceChangeRulesComplianceChangeRule1 = new ComplianceChangeRule();
$complianceChangeRulesComplianceChangeRule1->set@odatatype('#microsoft.graph.windowsUpdates.contentApprovalRule');

$additionalData = [
	'contentFilter' => $complianceChangeRulesComplianceChangeRule1 = new ContentFilter();
$	complianceChangeRulesComplianceChangeRule1->set@odatatype('#microsoft.graph.windowsUpdates.driverUpdateFilter');


$complianceChangeRulesComplianceChangeRule1->setContentFilter($contentFilter);

	'durationBeforeDeploymentStart' => 'P7D', 
];
$complianceChangeRulesComplianceChangeRule1->setAdditionalData($additionalData);



$complianceChangeRulesArray []= $complianceChangeRulesComplianceChangeRule1;
$requestBody->setComplianceChangeRules($complianceChangeRulesArray);


$deploymentSettings = new DeploymentSettings();
$deploymentSettings->set@odatatype('microsoft.graph.windowsUpdates.deploymentSettings');

$deploymentSettingsSchedule = new ScheduleSettings();
$deploymentSettingsScheduleGradualRollout = new GradualRolloutSettings();
$deploymentSettingsScheduleGradualRollout->set@odatatype('#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings');

$deploymentSettingsScheduleGradualRollout->setDurationBetweenOffers(new \DateInterval('P1D'));

$additionalData = [
'devicePerOffer' => 1000,
];
$deploymentSettingsScheduleGradualRollout->setAdditionalData($additionalData);



$deploymentSettingsSchedule->setGradualRollout($deploymentSettingsScheduleGradualRollout);

$deploymentSettings->setSchedule($deploymentSettingsSchedule);

$requestBody->setDeploymentSettings($deploymentSettings);


$result = $graphServiceClient->admin()->windows()->updates()->updatePolicies()->post($requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.WindowsUpdates

$params = @{
	"@odata.type" = "#microsoft.graph.windowsUpdates.updatePolicy"
	audience = @{
		id = "8c4eb1eb-d7a3-4633-8e2f-f926e82df08e"
	}
	complianceChanges = @(
		@{
			"@odata.type" = "#microsoft.graph.windowsUpdates.contentApproval"
		}
	)
	complianceChangeRules = @(
		@{
			"@odata.type" = "#microsoft.graph.windowsUpdates.contentApprovalRule"
			contentFilter = @{
				"@odata.type" = "#microsoft.graph.windowsUpdates.driverUpdateFilter"
			}
			durationBeforeDeploymentStart = "P7D"
		}
	)
	deploymentSettings = @{
		"@odata.type" = "microsoft.graph.windowsUpdates.deploymentSettings"
		schedule = @{
			gradualRollout = @{
				"@odata.type" = "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings"
				durationBetweenOffers = "P1D"
				devicePerOffer = 
			}
		}
	}
}

New-MgWindowsUpdatesPolicy -BodyParameter $params

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/windows/updates/updatePolicies/$entity",
    "id": "1b35b81b-f839-4951-882a-1fbfc6446409",
    "createdDateTime": "String (timestamp)",
    "autoEnrollmentUpdateCategories": [],
    "complianceChangeRules": [
        {
            "@odata.type": "#microsoft.graph.windowsUpdates.contentApprovalRule",
            "createdDateTime": "String (timestamp)",
            "lastEvaluatedDateTime": "String (timestamp)",
            "lastModifiedDateTime": "String (timestamp)",
            "durationBeforeDeploymentStart": "P7D",
            "contentFilter": {
                "@odata.type": "#microsoft.graph.windowsUpdates.driverUpdateFilter"
            }
        }
    ],
    "deploymentSettings": {
        "monitoring": null,
        "contentApplicability": null,
        "userExperience": null,
        "expedite": null,
        "schedule": {
            "startDateTime": "String (timestamp)",
            "gradualRollout": {
                "@odata.type": "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings",
                "durationBetweenOffers": "P1D",
                "devicesPerOffer": 0
            }
        }
    }
}