Chilkat Online Tools

phpExt / Microsoft Graph / Create deployment (date-based gradual rollout)

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "content": {
//     "@odata.type": "#microsoft.graph.windowsUpdates.featureUpdateReference",
//     "version": "{{FeatureUpdateVersion}}"
//   },
//   "settings": {
//     "@odata.type": "microsoft.graph.windowsUpdates.windowsDeploymentSettings",
//     "rollout": {
//       "startDateTime": "{{DeploymentStartDateTime}}",
//       "endDateTime": "{{DeploymentEndDateTime}}",
//       "durationBetweenOffers": "P7D"
//     },
//     "monitoring": {
//       "monitoringRules": [
//         {
//           "@odata.type": "#microsoft.graph.windowsUpdates.monitoringRule",
//           "signal": "rollback",
//           "threshold": 5,
//           "action": "pauseDeployment"
//         }
//       ]
//     }
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('content.\'@odata.type\'','#microsoft.graph.windowsUpdates.featureUpdateReference');
$json->UpdateString('content.version','{{FeatureUpdateVersion}}');
$json->UpdateString('settings.\'@odata.type\'','microsoft.graph.windowsUpdates.windowsDeploymentSettings');
$json->UpdateString('settings.rollout.startDateTime','{{DeploymentStartDateTime}}');
$json->UpdateString('settings.rollout.endDateTime','{{DeploymentEndDateTime}}');
$json->UpdateString('settings.rollout.durationBetweenOffers','P7D');
$json->UpdateString('settings.monitoring.monitoringRules[0].\'@odata.type\'','#microsoft.graph.windowsUpdates.monitoringRule');
$json->UpdateString('settings.monitoring.monitoringRules[0].signal','rollback');
$json->UpdateInt('settings.monitoring.monitoringRules[0].threshold',5);
$json->UpdateString('settings.monitoring.monitoringRules[0].action','pauseDeployment');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://graph.microsoft.com/beta/admin/windows/updates/deployments','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "content": {
        "@odata.type": "#microsoft.graph.windowsUpdates.featureUpdateReference",
        "version": "{{FeatureUpdateVersion}}"
    },
    "settings": {
        "@odata.type": "microsoft.graph.windowsUpdates.windowsDeploymentSettings",
        "rollout": {
            "startDateTime": "{{DeploymentStartDateTime}}",
            "endDateTime": "{{DeploymentEndDateTime}}",
            "durationBetweenOffers": "P7D"
        },
        "monitoring": {
            "monitoringRules": [
                {
                    "@odata.type": "#microsoft.graph.windowsUpdates.monitoringRule",
                    "signal": "rollback",
                    "threshold": 5,
                    "action": "pauseDeployment"
                }
            ]
        }
    }
}'
https://graph.microsoft.com/beta/admin/windows/updates/deployments

Postman Collection Item JSON

{
  "name": "Create deployment (date-based gradual rollout)",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "try {",
          "    if (responseBody.indexOf(\"InvalidAuthenticationToken\") !== -1)",
          "    {",
          "        console.log(\"You need to run *On behalf of a User | Get User Access Token* request first.\");",
          "    }",
          "    else",
          "    {",
          "        if (pm.response.status === \"Forbidden\")",
          "        {",
          "            console.log(\"You need to add user delegated permissions in your application to at least *WindowsUpdates.ReadWrite.All* in portal.azure.com and then grant admin consent. Afterwards, re-run *On behalf of a User | Get User Access Token* request to update access token.\");",
          "        }",
          "    }",
          "}",
          "catch (e) {",
          "    console.log(e);",
          "}",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"content\": {\n        \"@odata.type\": \"#microsoft.graph.windowsUpdates.featureUpdateReference\",\n        \"version\": \"{{FeatureUpdateVersion}}\"\n    },\n    \"settings\": {\n        \"@odata.type\": \"microsoft.graph.windowsUpdates.windowsDeploymentSettings\",\n        \"rollout\": {\n            \"startDateTime\": \"{{DeploymentStartDateTime}}\",\n            \"endDateTime\": \"{{DeploymentEndDateTime}}\",\n            \"durationBetweenOffers\": \"P7D\"\n        },\n        \"monitoring\": {\n            \"monitoringRules\": [\n                {\n                    \"@odata.type\": \"#microsoft.graph.windowsUpdates.monitoringRule\",\n                    \"signal\": \"rollback\",\n                    \"threshold\": 5,\n                    \"action\": \"pauseDeployment\"\n                }\n            ]\n        }\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://graph.microsoft.com/beta/admin/windows/updates/deployments",
      "protocol": "https",
      "host": [
        "graph",
        "microsoft",
        "com"
      ],
      "path": [
        "beta",
        "admin",
        "windows",
        "updates",
        "deployments"
      ]
    }
  },
  "response": [
  ]
}