ManagedServicesPlan Object

Description

Specification for a Managed Services Backup or Start/Stop Plan.

Properties

createdDate

Date, in ISO 8601 format, at which the plan was created.

Type: bool

isDeleted

Indicated whether the Managed Services Plan has been deleted.

Type: bool

isEnabled

Indicated whether the Managed Services Plan is enabled.

Type: bool

lastModifiedBy

User ID of the user that last modified the plan.

Type: string

lastModifiedDate

Date, in ISO 8601 format, at which the plan was last modified.

Type: bool

name

Name of the Managed Services Plan.

Type: string

parameters

Additional parameters for the plan. The object value is dependent on the value of planType.

Type: ManagedServicesPlanParameters object.

planId

Identifier for the Managed Services Plan.

Type: string

planType

Type of Managed Services Plan.

Type: string

Allowed Values:

  • backup-plan

  • start-stop-plan

projectId

The project in which the plan is contained.

Type: string

schedule

The schedule for the Managed Services Plan.

Type: ManagedServicesPlanSchedule object

state

State of the Managed Services Plan.

Type: string

Allowed Values:

  • active

  • deleted

  • disabled

Sample JSON

{
    "planId": "plan-00000001",
    "projectId": "proj-00000001",
    "planType": "start-stop-plan",
    "name": "Start Development Environment",
    
    "state": "active",
    "isEnabled": true,
    "isDeleted": false,
    
    "createdDate": "2023-02-13T00:00:00Z",
    "lastModifiedDate": "2023-02-14T00:00:00Z",
    "lastModifiedBy": "u-00000001",
    
    "schedule": {
        "scheduleType": "daily",
        "timeOfDay": "08:00:00",
        "timeZoneId": "Eastern Standard Time",
        "parameters": {
            "days": [
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday"
            ]
        }
    },
    
    "parameters": {
        "startStopMode": "start-stop-combined",
        "stopTimeInSeconds": 43200
    }
}

Last updated