Chilkat Online Tools

TCL / Microsoft Graph / Create deployment (rate-based gradual rollout)

Back to Collection Items

load ./chilkat.dll

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

set 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": {
#       "devicesPerOffer": 100,
#       "durationBetweenOffers": "P7D"
#     },
#     "monitoring": {
#       "monitoringRules": [
#         {
#           "@odata.type": "#microsoft.graph.windowsUpdates.monitoringRule",
#           "signal": "rollback",
#           "threshold": 5,
#           "action": "pauseDeployment"
#         }
#       ]
#     }
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "content.\"@odata.type\"" "#microsoft.graph.windowsUpdates.featureUpdateReference"
CkJsonObject_UpdateString $json "content.version" "{{FeatureUpdateVersion}}"
CkJsonObject_UpdateString $json "settings.\"@odata.type\"" "microsoft.graph.windowsUpdates.windowsDeploymentSettings"
CkJsonObject_UpdateInt $json "settings.rollout.devicesPerOffer" 100
CkJsonObject_UpdateString $json "settings.rollout.durationBetweenOffers" "P7D"
CkJsonObject_UpdateString $json "settings.monitoring.monitoringRules[0].\"@odata.type\"" "#microsoft.graph.windowsUpdates.monitoringRule"
CkJsonObject_UpdateString $json "settings.monitoring.monitoringRules[0].signal" "rollback"
CkJsonObject_UpdateInt $json "settings.monitoring.monitoringRules[0].threshold" 5
CkJsonObject_UpdateString $json "settings.monitoring.monitoringRules[0].action" "pauseDeployment"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://graph.microsoft.com/beta/admin/windows/updates/deployments" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

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": {
            "devicesPerOffer": 100,
            "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 (rate-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            \"devicesPerOffer\": 100,\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": [
  ]
}