| POST | /compute/datacenter/{datacenterLocation}/org/{subscriptionId}/resourcegroup/{resourceGroup}/vm/{vmName}/power/{powerStatus} | Enact the desired Power Status change on the VM |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| datacenterLocation | path | DatacenterLocations | No | Allowable Values
|
| vmName | path | string | No | |
| powerStatus | path | PowerStatus | No | Allowable Values
|
| subscriptionId | path | string | No | |
| resourceGroup | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| userId | form | string | No | |
| logins | form | List<TypeLogin> | No | |
| sessionId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MembershipId | form | int | No | |
| UserId | form | Guid | No | |
| Username | form | string | No | |
| Password | form | string | No | |
| DatacenterURL | form | string | No | |
| LocationType | form | string | No | |
| Location | form | string | No | |
| DatacenterLocation | form | DatacenterLocations | No | |
| ApplicationName | form | string | No | |
| ApplicationId | form | Guid | No | |
| ApplicationLocationId | form | Guid | No | |
| CompanyName | form | string | No | |
| CompanyId | form | Guid | No | |
| Status | form | int | No | |
| Rights | form | List<string> | No | |
| SessionId | form | string | No | |
| Roles | form | List<string> | No | |
| Permissions | form | List<string> | No | |
| Attributes | form | List<TypeMembershipAttribute> | No | |
| UseTwoFactorAuth | form | bool | No | |
| PresharedKey | form | string | No | |
| Passcode | form | string | No | |
| Id | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No |
| GMU | |
| SPA | |
| LAS | |
| DEV | |
| VCD | |
| AWS | |
| GCP | |
| UAT | |
| AZU | |
| AUV | |
| ATL |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttributeType | form | string | No | |
| AttributeValue | form | string | No | |
| AttributeDataType | form | string | No |
| ACD | |
| GMU | |
| SPA | |
| LAS | |
| DEV | |
| VCD | |
| AWS | |
| GCP | |
| UAT | |
| AZU | |
| CNW | |
| AUV | |
| ATL | |
| EXT |
| Name | Value | |
|---|---|---|
| OFF | 0 | |
| ON | 1 | |
| SHUTDOWN | 3 | |
| SUSPEND | 4 | |
| RESTART | 5 | |
| RESUME | 6 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /compute/datacenter/{datacenterLocation}/org/{subscriptionId}/resourcegroup/{resourceGroup}/vm/{vmName}/power/{powerStatus} HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
datacenterLocation: ACD,
vmName: String,
powerStatus: OFF,
subscriptionId: String,
resourceGroup: String,
userId: String,
logins:
[
{
membershipId: 0,
userId: 00000000000000000000000000000000,
username: String,
password: String,
datacenterURL: String,
locationType: String,
location: String,
datacenterLocation: GMU,
applicationName: String,
applicationId: 00000000000000000000000000000000,
applicationLocationId: 00000000000000000000000000000000,
companyName: String,
companyId: 00000000000000000000000000000000,
status: 0,
rights:
[
String
],
sessionId: String,
roles:
[
String
],
permissions:
[
String
],
attributes:
[
{
attributeType: String,
attributeValue: String,
attributeDataType: String
}
],
useTwoFactorAuth: False,
presharedKey: String,
passcode: String,
id: String,
firstName: String,
lastName: String
}
],
sessionId: String
}