Create deployment

Article
02/03/2023

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 deployment 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/deployments

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 deployment object.

The following table shows the properties that are required when you create the deployment.

Property	Type	Description
audience	microsoft.graph.windowsUpdates.deploymentAudience	Specifies the audience to target.
content	microsoft.graph.windowsUpdates.deployableContent	Specifies what content to deploy. Deployable content should be provided as one of the following derived types: catalogContent.

Response

If successful, this method returns a 201 Created response code and a deployment object in the response body.

Example

Request

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

{
    "@odata.type": "#microsoft.graph.windowsUpdates.deployment",
    "content": {
        "@odata.type": "#microsoft.graph.windowsUpdates.catalogContent",
        "catalogEntry": {
            "@odata.type": "#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry",
            "id": "f341705b-0b15-4ce3-aaf2-6a1681d78606"
        }
    },
    "settings": {
        "@odata.type": "microsoft.graph.windowsUpdates.deploymentSettings",
        "schedule": {
            "gradualRollout": {
                "@odata.type": "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings",
                "durationBetweenOffers": "P7D",
                "devicePerOffer": 100
            }
        },
        "monitoring": {
            "monitoringRules": [
                {
                    "signal": "rollback",
                    "threshold": 5,
                    "action": "pauseDeployment"
                }
            ]
        }
    }
}


// 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.Deployment
{
	OdataType = "#microsoft.graph.windowsUpdates.deployment",
	Content = new Microsoft.Graph.Beta.Models.WindowsUpdates.DeployableContent
	{
		OdataType = "#microsoft.graph.windowsUpdates.catalogContent",
		AdditionalData = new Dictionary<string, object>
		{
			{
				"catalogEntry" , new 
				{
					OdataType = "#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry",
					Id = "f341705b-0b15-4ce3-aaf2-6a1681d78606",
				}
			},
		},
	},
	Settings = 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("P7D"),
				AdditionalData = new Dictionary<string, object>
				{
					{
						"devicePerOffer" , 100
					},
				},
			},
		},
		Monitoring = new Microsoft.Graph.Beta.Models.WindowsUpdates.MonitoringSettings
		{
			MonitoringRules = new List<Microsoft.Graph.Beta.Models.WindowsUpdates.MonitoringRule>
			{
				new Microsoft.Graph.Beta.Models.WindowsUpdates.MonitoringRule
				{
					Signal = Microsoft.Graph.Beta.Models.WindowsUpdates.MonitoringSignal.Rollback,
					Threshold = 5,
					Action = Microsoft.Graph.Beta.Models.WindowsUpdates.MonitoringAction.PauseDeployment,
				},
			},
		},
	},
};
var result = await graphClient.Admin.Windows.Updates.Deployments.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.



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.NewDeployment()
content := graphmodels.NewDeployableContent()
additionalData := map[string]interface{}{
catalogEntry := graphmodels.New()
id := "f341705b-0b15-4ce3-aaf2-6a1681d78606"
catalogEntry.SetId(&id) 
	content.SetCatalogEntry(catalogEntry)
}
content.SetAdditionalData(additionalData)
requestBody.SetContent(content)
settings := graphmodels.NewDeploymentSettings()
schedule := graphmodels.NewScheduleSettings()
gradualRollout := graphmodels.NewGradualRolloutSettings()
durationBetweenOffers , err := abstractions.ParseISODuration("P7D")
gradualRollout.SetDurationBetweenOffers(&durationBetweenOffers) 
additionalData := map[string]interface{}{
	"devicePerOffer" : int32(100) , 
}
gradualRollout.SetAdditionalData(additionalData)
schedule.SetGradualRollout(gradualRollout)
settings.SetSchedule(schedule)
monitoring := graphmodels.NewMonitoringSettings()


monitoringRule := graphmodels.NewMonitoringRule()
signal := graphmodels.ROLLBACK_MONITORINGSIGNAL 
monitoringRule.SetSignal(&signal) 
threshold := int32(5)
monitoringRule.SetThreshold(&threshold) 
action := graphmodels.PAUSEDEPLOYMENT_MONITORINGACTION 
monitoringRule.SetAction(&action) 

monitoringRules := []graphmodels.MonitoringRuleable {
	monitoringRule,

}
monitoring.SetMonitoringRules(monitoringRules)
settings.SetMonitoring(monitoring)
requestBody.SetSettings(settings)

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

Important

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


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

Deployment deployment = new Deployment();
CatalogContent content = new CatalogContent();
FeatureUpdateCatalogEntry catalogEntry = new FeatureUpdateCatalogEntry();
catalogEntry.id = "f341705b-0b15-4ce3-aaf2-6a1681d78606";
content.catalogEntry = catalogEntry;
deployment.content = content;
DeploymentSettings settings = new DeploymentSettings();
ScheduleSettings schedule = new ScheduleSettings();
RateDrivenRolloutSettings gradualRollout = new RateDrivenRolloutSettings();
gradualRollout.durationBetweenOffers = DatatypeFactory.newInstance().newDuration("P7D");
gradualRollout.devicePerOffer = 100;
schedule.gradualRollout = gradualRollout;
settings.schedule = schedule;
MonitoringSettings monitoring = new MonitoringSettings();
LinkedList<MonitoringRule> monitoringRulesList = new LinkedList<MonitoringRule>();
MonitoringRule monitoringRules = new MonitoringRule();
monitoringRules.signal = MonitoringSignal.ROLLBACK;
monitoringRules.threshold = 5;
monitoringRules.action = MonitoringAction.PAUSE_DEPLOYMENT;
monitoringRulesList.add(monitoringRules);
monitoring.monitoringRules = monitoringRulesList;
settings.monitoring = monitoring;
deployment.settings = settings;

graphClient.admin().windows().updates().deployments()
	.buildRequest()
	.post(deployment);

Important

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


const options = {
	authProvider,
};

const client = Client.init(options);

const deployment = {
    '@odata.type': '#microsoft.graph.windowsUpdates.deployment',
    content: {
        '@odata.type': '#microsoft.graph.windowsUpdates.catalogContent',
        catalogEntry: {
            '@odata.type': '#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry',
            id: 'f341705b-0b15-4ce3-aaf2-6a1681d78606'
        }
    },
    settings: {
        '@odata.type': 'microsoft.graph.windowsUpdates.deploymentSettings',
        schedule: {
            gradualRollout: {
                '@odata.type': '#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings',
                durationBetweenOffers: 'P7D',
                devicePerOffer: 100
            }
        },
        monitoring: {
            monitoringRules: [
                {
                    signal: 'rollback',
                    threshold: 5,
                    action: 'pauseDeployment'
                }
            ]
        }
    }
};

await client.api('/admin/windows/updates/deployments')
	.version('beta')
	.post(deployment);

Important

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


<?php

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

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

$content = new DeployableContent();
$content->set@odatatype('#microsoft.graph.windowsUpdates.catalogContent');

$additionalData = [
		'catalogEntry' => $content = new CatalogEntry();
$		content->set@odatatype('#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry');

$		content->setId('f341705b-0b15-4ce3-aaf2-6a1681d78606');


$content->setCatalogEntry($catalogEntry);

];
$content->setAdditionalData($additionalData);



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

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

$settingsScheduleGradualRollout->setDurationBetweenOffers(new \DateInterval('P7D'));

$additionalData = [
		'devicePerOffer' => 100,
];
$settingsScheduleGradualRollout->setAdditionalData($additionalData);



$settingsSchedule->setGradualRollout($settingsScheduleGradualRollout);

$settings->setSchedule($settingsSchedule);
$settingsMonitoring = new MonitoringSettings();
$monitoringRulesMonitoringRule1 = new MonitoringRule();
$monitoringRulesMonitoringRule1->setSignal(new MonitoringSignal('rollback'));

$monitoringRulesMonitoringRule1->setThreshold(5);

$monitoringRulesMonitoringRule1->setAction(new MonitoringAction('pausedeployment'));


$monitoringRulesArray []= $monitoringRulesMonitoringRule1;
$settingsMonitoring->setMonitoringRules($monitoringRulesArray);



$settings->setMonitoring($settingsMonitoring);

$requestBody->setSettings($settings);


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

Important

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


Import-Module Microsoft.Graph.WindowsUpdates

$params = @{
	"@odata.type" = "#microsoft.graph.windowsUpdates.deployment"
	content = @{
		"@odata.type" = "#microsoft.graph.windowsUpdates.catalogContent"
		catalogEntry = @{
			"@odata.type" = "#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry"
			id = "f341705b-0b15-4ce3-aaf2-6a1681d78606"
		}
	}
	settings = @{
		"@odata.type" = "microsoft.graph.windowsUpdates.deploymentSettings"
		schedule = @{
			gradualRollout = @{
				"@odata.type" = "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings"
				durationBetweenOffers = "P7D"
				devicePerOffer = 
			}
		}
		monitoring = @{
			monitoringRules = @(
				@{
					signal = "rollback"
					threshold = 5
					action = "pauseDeployment"
				}
			)
		}
	}
}

New-MgWindowsUpdatesDeployment -BodyParameter $params

Important

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

Response

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

{
  "@odata.type": "#microsoft.graph.windowsUpdates.deployment",
  "id": "b5171742-1742-b517-4217-17b5421717b5",
  "createdDateTime": "2023-01-26T05:08:38.118213Z",
  "lastModifiedDateTime": "2023-01-26T05:08:38Z",
  "state": {
    "value": "offering",
    "reasons": [],
    "requestedValue": "none",
  },
  "content": {
    "@odata.type": "microsoft.graph.windowsUpdates.catalogContent",
  },
  "settings": {
    "@odata.type": "microsoft.graph.windowsUpdates.deploymentSettings",
    "schedule": {
      "gradualRollout": {
        "@odata.type": "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings",
        "durationBetweenOffers": "P1D",
        "devicePerOffer": 1000
      }
    },
    "monitoring": {
      "monitoringRules": [
        {
          "@odata.type": "#microsoft.graph.windowsUpdates.monitoringRule",
          "signal": "rollback",
          "threshold": 5,
          "action": "pauseDeployment"
        }
      ]
    },
    "userExperience": null,
    "safeguard": null
  },
}

Create deployment

Permissions

HTTP request

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources

Additional resources