Platform
Manage platforms and their settings.
List all platforms
Returns every platform, including built-in and custom platforms. Each platform carries the identifiers of its password complexity policy and schedules; the linked policy and schedule objects themselves are not included. Use the details route to get them for one platform.
Create a custom platform
Creates a custom platform, its command plan templates and a resource group for the platform. The new platform is always based on the custom platform and shows command plans, whatever values are sent for those settings.
Copy a platform
Creates a copy of the platform with the given identifier, including its command plans, and returns the new platform. The copy is named after the original with 'Copy' appended (numbered if copies already exist), is not permanent, and uses the same password complexity policy and schedules as the original.
List platform names and identifiers
Returns the name, identifier, base platform identifier and permanent flag of each platform, sorted by name. Use it to populate platform pickers. The base platform that custom platforms build on is never listed; the includeBaseId flag controls whether the Unspecified platform is listed.
List platform names by platform type
Returns the name, identifier, base platform identifier and permanent flag of every platform of one type, such as cloud or database, sorted by name.
Delete a custom platform
Deletes the platform with the given identifier, along with its command plans and the resource group that mirrors the platform. Built-in (permanent) platforms cannot be deleted.
Get a platform
Returns the platform with the given identifier.
Update a platform
Replaces the settings of the platform with the given identifier and applies any schedule changes to the platform's scheduled jobs. The identifier in the body must match the path, and the name must not be used by another platform (not case-sensitive). A built-in platform keeps its existing name whatever name is sent.
Get a platform with its policies and schedules
Returns the platform with the given identifier, with its password complexity policy and its password change, protection policy and scan schedules filled in. The verification schedule is returned by identifier only.
Map an operating system to a platform
Associates an operating system name with the platform so resources whose reported operating system contains that name are matched to the platform. Fails if that operating system name is already mapped to any platform; the comparison is not case-sensitive.