Cloud Services - Get Instance View

Gets the status of a cloud service.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/instanceView?api-version=2021-03-01

URI Parameters

Name In Required Type Description
cloudServiceName
path True
  • string

Name of the cloud service.

resourceGroupName
path True
  • string

Name of the resource group.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Error

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get Cloud Service Instance View with Multiple Roles

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/instanceView?api-version=2021-03-01

Sample Response

{
  "roleInstance": {
    "statusesSummary": [
      {
        "code": "ProvisioningState/succeeded",
        "count": 4
      },
      {
        "code": "PowerState/started",
        "count": 4
      },
      {
        "code": "RoleState/RoleStateStarted",
        "count": 4
      }
    ]
  },
  "sdkVersion": "2.9.6496.3",
  "privateIds": [
    "3491bc0c-1f6c-444f-b1d0-ec0751a74e3e"
  ],
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2021-01-12T16:50:07.0953535+05:30"
    },
    {
      "code": "PowerState/started",
      "level": "Info",
      "displayStatus": "Started",
      "time": "2021-01-12T16:50:07.0953535+05:30"
    },
    {
      "code": "CurrentUpgradeDomain/-1",
      "level": "Info",
      "displayStatus": "Current Upgrade Domain of cloud service is -1."
    },
    {
      "code": "MaxUpgradeDomain/1",
      "level": "Info",
      "displayStatus": "Max Upgrade Domain of cloud service is 1."
    }
  ]
}

Definitions

ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

CloudServiceInstanceView

InstanceView of CloudService as a whole

InnerError

Inner error details.

InstanceViewStatusesSummary

Instance view statuses.

ResourceInstanceViewStatus

Instance view status.

StatusCodeCount
StatusLevelTypes

The level code.

ApiError

Api error.

Name Type Description
code
  • string

The error code.

details

The Api error details

innererror

The Api inner error

message
  • string

The error message.

target
  • string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

Api error.

CloudServiceInstanceView

InstanceView of CloudService as a whole

Name Type Description
privateIds
  • string[]

Specifies a list of unique identifiers generated internally for the cloud service.

NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.

roleInstance

Instance view statuses.

sdkVersion
  • string

The version of the SDK that was used to generate the package for the cloud service.

statuses

Instance view status.

InnerError

Inner error details.

Name Type Description
errordetail
  • string

The internal error message or exception dump.

exceptiontype
  • string

The exception type.

InstanceViewStatusesSummary

Instance view statuses.

Name Type Description
statusesSummary

ResourceInstanceViewStatus

Instance view status.

Name Type Description
code
  • string

The status code.

displayStatus
  • string

The short localizable label for the status.

level

The level code.

message
  • string

The detailed status message, including for alerts and error messages.

time
  • string

The time of the status.

StatusCodeCount

Name Type Description
code
  • string

The instance view status code

count
  • integer

Number of instances having this status code

StatusLevelTypes

The level code.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string