Microsoft Azure

Azure Compute: Cloud Service

The Cloud Service Management Client.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Cloud Service Management Client.

Endpoints 30

CloudServiceRoleInstances

  • GETCloudServiceRoleInstances_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName?$expand=instanceViewGets a role instance from a cloud service.
  • DELETECloudServiceRoleInstances_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceNameDeletes a role instance from a cloud service.
  • GETCloudServiceRoleInstances_GetInstanceView/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName/instanceViewRetrieves information about the run-time state of a role instance in a cloud service.
  • GETCloudServiceRoleInstances_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances?$expand=instanceViewGets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is…
  • POSTCloudServiceRoleInstances_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName/restartThe Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.
  • POSTCloudServiceRoleInstances_Reimage/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName/reimageThe Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
  • POSTCloudServiceRoleInstances_Rebuild/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName/rebuildThe Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage…
  • GETCloudServiceRoleInstances_GetRemoteDesktopFile/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName/remoteDesktopFileGets a remote desktop file for a role instance in a cloud service.

CloudServiceRoles

  • GETCloudServiceRoles_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roles/:roleNameGets a role from a cloud service.
  • GETCloudServiceRoles_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/rolesGets a list of all roles in a cloud service. Use nextLink property in the response to get the next page of roles. Do this till nextLink is null to fetch all…

CloudServices

  • GETCloudServices_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceNameDisplay information about a cloud service.
  • PUTCloudServices_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceNameCreate or update a cloud service. Please note some properties can be set only during cloud service creation.
  • DELETECloudServices_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceNameDeletes a cloud service.
  • PATCHCloudServices_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceNameUpdate a cloud service.
  • GETCloudServices_GetInstanceView/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/instanceViewGets the status of a cloud service.
  • GETCloudServices_ListAll/subscriptions/:subscriptionId/providers/Microsoft.Compute/cloudServicesGets a list of all cloud services in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page…
  • GETCloudServices_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServicesGets a list of all cloud services under a resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink…
  • POSTCloudServices_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/startStarts the cloud service.
  • POSTCloudServices_PowerOff/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/poweroffPower off the cloud service. Note that resources are still attached and you are getting charged for the resources.
  • POSTCloudServices_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/restartRestarts one or more role instances in a cloud service.
  • POSTCloudServices_Reimage/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/reimageReimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
  • POSTCloudServices_Rebuild/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/rebuildRebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them.…
  • POSTCloudServices_DeleteInstances/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/deleteDeletes role instances in a cloud service.

CloudServicesUpdateDomain

  • GETCloudServicesUpdateDomain_GetUpdateDomain/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/updateDomains/:updateDomainGets the specified update domain of a cloud service. Use nextLink property in the response to get the next page of update domains. Do this till nextLink is…
  • PUTCloudServicesUpdateDomain_WalkUpdateDomain/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/updateDomains/:updateDomainUpdates the role instances in the specified update domain.
  • GETCloudServicesUpdateDomain_ListUpdateDomains/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/updateDomainsGets a list of all update domains in a cloud service.

CloudServiceOperatingSystems

  • GETCloudServiceOperatingSystems_GetOSVersion/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/cloudServiceOsVersions/:osVersionNameGets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service.
  • GETCloudServiceOperatingSystems_ListOSVersions/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/cloudServiceOsVersionsGets a list of all guest operating system versions available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink…
  • GETCloudServiceOperatingSystems_GetOSFamily/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/cloudServiceOsFamilies/:osFamilyNameGets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service.
  • GETCloudServiceOperatingSystems_ListOSFamilies/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/cloudServiceOsFamiliesGets a list of all guest operating system families available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink…

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
30 operations on 25 pathsGET 16POST 9PUT 2DELETE 2PATCH 1
Main resources
CloudServices 13CloudServiceRoleInstances 8CloudServiceOperatingSystems 4CloudServicesUpdateDomain 3CloudServiceRoles 2
Response formats
application/json
Description format
Swagger 2.0, API version 2024-11-04

How to test the Azure Compute: Cloud Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Compute: Cloud Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “CloudServiceRoleInstances_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/cloudServices/:cloudServiceName/roleInstances/:roleInstanceName?$expand=instanceView), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Compute: Cloud Service?

The Cloud Service Management Client. It is listed under Developer tools and has 30 endpoints.

Who publishes the Azure Compute: Cloud Service?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Compute: Cloud Service?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Compute: Cloud Service?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Compute: Cloud Service have?

30 operations on 25 paths (16 GET, 9 POST, 2 PUT, 2 DELETE, 1 PATCH). The largest groups are CloudServices, CloudServiceRoleInstances, CloudServiceOperatingSystems, CloudServicesUpdateDomain.

Is forking the Azure Compute: Cloud Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.