swagger: '2.0' info: title: Microsoft Azure CloudServiceManagementClient description: The Cloud Service Management Client. version: '2022-04-04' host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName} : delete: tags: - CloudServiceRoleInstances description: Deletes a role instance from a cloud service. operationId: microsoftAzureCloudserviceroleinstancesDelete parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Delete Cloud Service Role Instance: $ref: ./examples/CloudServiceRoleInstance_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename get: tags: - CloudServiceRoleInstances description: Gets a role instance from a cloud service. operationId: microsoftAzureCloudserviceroleinstancesGet parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: query name: $expand description: >- The expand expression to apply to the operation. 'UserData' is not supported for cloud services. type: string enum: - instanceView - userData x-ms-enum: name: InstanceViewTypes modelAsString: false responses: '200': description: OK schema: $ref: '#/definitions/RoleInstance' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service Role Instance: $ref: ./examples/CloudServiceRoleInstance_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/instanceView : get: tags: - CloudServiceRoleInstances description: >- Retrieves information about the run-time state of a role instance in a cloud service. operationId: microsoftAzureCloudserviceroleinstancesGetinstanceview parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/RoleInstanceInstanceView' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Instance View of Cloud Service Role Instance: $ref: ./examples/CloudServiceRoleInstance_Get_InstanceView.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename Instanceview ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances : get: tags: - CloudServiceRoleInstances description: >- Gets 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 null to fetch all the role instances. operationId: microsoftAzureCloudserviceroleinstancesList parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: query name: $expand description: >- The expand expression to apply to the operation. 'UserData' is not supported for cloud services. type: string enum: - instanceView - userData x-ms-enum: name: InstanceViewTypes modelAsString: false responses: '200': description: OK schema: $ref: '#/definitions/RoleInstanceListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Role Instances in a Cloud Service: $ref: ./examples/CloudServiceRolesInstance_List.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/restart : post: tags: - CloudServiceRoleInstances description: >- The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. operationId: microsoftAzureCloudserviceroleinstancesRestart parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Restart Cloud Service Role Instance: $ref: ./examples/CloudServiceRoleInstance_Restart.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename Restart ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/reimage : post: tags: - CloudServiceRoleInstances description: >- The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. operationId: microsoftAzureCloudserviceroleinstancesReimage parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Reimage Cloud Service Role Instance: $ref: ./examples/CloudServiceRoleInstance_Reimage.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename Reimage ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/rebuild : post: tags: - CloudServiceRoleInstances description: >- The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance. operationId: microsoftAzureCloudserviceroleinstancesRebuild parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Rebuild Cloud Service Role Instance: $ref: ./examples/CloudServiceRoleInstance_Rebuild.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename Rebuild ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/remoteDesktopFile : get: tags: - CloudServiceRoleInstances description: Gets a remote desktop file for a role instance in a cloud service. operationId: microsoftAzureCloudserviceroleinstancesGetremotedesktopfile produces: - application/x-rdp parameters: - in: path name: roleInstanceName description: Name of the role instance. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: format: binary type: file default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service Role: $ref: ./examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roleinstances Roleinstancename Remotedesktopfile ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roles/{roleName} : get: tags: - CloudServiceRoles description: Gets a role from a cloud service. operationId: microsoftAzureCloudservicerolesGet parameters: - in: path name: roleName description: Name of the role. required: true type: string - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServiceRole' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service Role: $ref: ./examples/CloudServiceRole_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roles Rolename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roles : get: tags: - CloudServiceRoles description: >- Gets 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 the roles. operationId: microsoftAzureCloudservicerolesList parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServiceRoleListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Roles in a Cloud Service: $ref: ./examples/CloudServiceRole_List.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Roles ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName} : put: tags: - CloudServices description: >- Create or update a cloud service. Please note some properties can be set only during cloud service creation. operationId: microsoftAzureCloudservicesCreateorupdate parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: The cloud service object. schema: $ref: '#/definitions/CloudService' responses: '200': description: OK schema: $ref: '#/definitions/CloudService' '201': description: Created schema: $ref: '#/definitions/CloudService' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Create New Cloud Service with Single Role: $ref: ./examples/CloudService_Create_WithSingleRole.json Create New Cloud Service with Single Role and RDP Extension: $ref: ./examples/CloudService_Create_WithSingleRoleAndRDP.json Create New Cloud Service with Multiple Roles: $ref: ./examples/CloudService_Create_WithMultiRole.json Create New Cloud Service with Single Role and Certificate from Key Vault: $ref: ./examples/CloudService_Create_WithSingleRoleAndCertificate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename patch: tags: - CloudServices description: Update a cloud service. operationId: microsoftAzureCloudservicesUpdate parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: The cloud service object. schema: $ref: '#/definitions/CloudServiceUpdate' responses: '200': description: OK schema: $ref: '#/definitions/CloudService' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Update existing Cloud Service to add tags: $ref: ./examples/CloudService_Update_ToIncludeTags.json summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename delete: tags: - CloudServices description: Deletes a cloud service. operationId: microsoftAzureCloudservicesDelete parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Delete Cloud Service: $ref: ./examples/CloudService_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename get: tags: - CloudServices description: Display information about a cloud service. operationId: microsoftAzureCloudservicesGet parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudService' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service with Multiple Roles and RDP Extension: $ref: ./examples/CloudService_Get_WithMultiRoleAndRDP.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/instanceView : get: tags: - CloudServices description: Gets the status of a cloud service. operationId: microsoftAzureCloudservicesGetinstanceview parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServiceInstanceView' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service Instance View with Multiple Roles: $ref: ./examples/CloudService_Get_InstanceViewWithMultiRole.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Instanceview /subscriptions/{subscriptionId}/providers/Microsoft.Compute/cloudServices: get: tags: - CloudServices description: >- Gets 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 of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services. operationId: microsoftAzureCloudservicesListall parameters: - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServiceListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Cloud Services in a Subscription: $ref: ./examples/CloudService_List_BySubscription.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Cloudservices /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices: get: tags: - CloudServices description: >- Gets 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 is null to fetch all the Cloud Services. operationId: microsoftAzureCloudservicesList parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServiceListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Cloud Services in a Resource Group: $ref: ./examples/CloudService_List_ByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/start : post: tags: - CloudServices description: Starts the cloud service. operationId: microsoftAzureCloudservicesStart parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Start Cloud Service: $ref: ./examples/CloudService_Start.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Start ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/poweroff : post: tags: - CloudServices description: >- Power off the cloud service. Note that resources are still attached and you are getting charged for the resources. operationId: microsoftAzureCloudservicesPoweroff parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Stop or PowerOff Cloud Service: $ref: ./examples/CloudService_PowerOff.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Poweroff ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/restart : post: tags: - CloudServices description: Restarts one or more role instances in a cloud service. operationId: microsoftAzureCloudservicesRestart parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: List of cloud service role instance names. schema: $ref: '#/definitions/RoleInstances' responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Restart Cloud Service Role Instances in a Cloud Service: $ref: ./examples/CloudServiceRoleInstance_Restart_ByCloudService.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Restart ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/reimage : post: tags: - CloudServices description: >- Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles. operationId: microsoftAzureCloudservicesReimage parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: List of cloud service role instance names. schema: $ref: '#/definitions/RoleInstances' responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Reimage Cloud Service Role Instances in a Cloud Service: $ref: ./examples/CloudServiceRoleInstance_Reimage_ByCloudService.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Reimage ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/rebuild : post: tags: - CloudServices description: >- Rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instances. operationId: microsoftAzureCloudservicesRebuild parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: List of cloud service role instance names. schema: $ref: '#/definitions/RoleInstances' responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Rebuild Cloud Service Role Instances in a Cloud Service: $ref: ./examples/CloudServiceRoleInstance_Rebuild_ByCloudService.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Rebuild ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/delete : post: tags: - CloudServices description: Deletes role instances in a cloud service. operationId: microsoftAzureCloudservicesDeleteinstances parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: List of cloud service role instance names. schema: $ref: '#/definitions/RoleInstances' responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Delete Cloud Service Role Instances in a Cloud Service: $ref: ./examples/CloudServiceRoleInstance_Delete_ByCloudService.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Delete ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/updateDomains/{updateDomain} : put: tags: - CloudServicesUpdateDomain description: Updates the role instances in the specified update domain. operationId: microsoftAzureCloudservicesupdatedomainWalkupdatedomain parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - in: path name: updateDomain description: >- Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. required: true type: integer format: int32 - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter - in: body name: parameters description: The update domain object. schema: $ref: '#/definitions/UpdateDomain' responses: '200': description: OK '202': description: Accepted default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-examples: Update Cloud Service to specified Domain: $ref: ./examples/CloudServiceUpdateDomain_Update.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Updatedomains Updatedomain get: tags: - CloudServicesUpdateDomain description: >- Gets 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 null to fetch all the update domains. operationId: microsoftAzureCloudservicesupdatedomainGetupdatedomain parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - in: path name: updateDomain description: >- Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. required: true type: integer format: int32 - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/UpdateDomain' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service Update Domain: $ref: ./examples/CloudServiceUpdateDomain_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Updatedomains Updatedomain ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/updateDomains : get: tags: - CloudServicesUpdateDomain description: Gets a list of all update domains in a cloud service. operationId: microsoftAzureCloudservicesupdatedomainListupdatedomains parameters: - in: path name: resourceGroupName description: Name of the resource group. required: true type: string - in: path name: cloudServiceName description: Name of the cloud service. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/UpdateDomainListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Update Domains in Cloud Service: $ref: ./examples/CloudServiceUpdateDomain_List.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Cloudservices Cloudservicename Updatedomains /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsVersions/{osVersionName}: get: tags: - CloudServiceOperatingSystems description: >- Gets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service. operationId: microsoftAzureCloudserviceoperatingsystemsGetosversion parameters: - in: path name: location description: Name of the location that the OS version pertains to. required: true type: string - in: path name: osVersionName description: Name of the OS version. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OSVersion' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service OS Version: $ref: ./examples/CloudServiceOSVersion_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Cloudserviceosversions Osversionname /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsVersions: get: tags: - CloudServiceOperatingSystems description: >- Gets a list of all guest operating system versions available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink property in the response to get the next page of OS versions. Do this till nextLink is null to fetch all the OS versions. operationId: microsoftAzureCloudserviceoperatingsystemsListosversions parameters: - in: path name: location description: Name of the location that the OS versions pertain to. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OSVersionListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Cloud Service OS Versions in a subscription: $ref: ./examples/CloudServiceOSVersion_List.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Cloudserviceosversions /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsFamilies/{osFamilyName}: get: tags: - CloudServiceOperatingSystems description: >- Gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service. operationId: microsoftAzureCloudserviceoperatingsystemsGetosfamily parameters: - in: path name: location description: Name of the location that the OS family pertains to. required: true type: string - in: path name: osFamilyName description: Name of the OS family. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OSFamily' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: Get Cloud Service OS Family: $ref: ./examples/CloudServiceOSFamily_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Cloudserviceosfamilies Osfamilyname /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsFamilies: get: tags: - CloudServiceOperatingSystems description: >- Gets a list of all guest operating system families available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink property in the response to get the next page of OS Families. Do this till nextLink is null to fetch all the OS Families. operationId: microsoftAzureCloudserviceoperatingsystemsListosfamilies parameters: - in: path name: location description: Name of the location that the OS families pertain to. required: true type: string - $ref: ./common.json#/parameters/SubscriptionIdParameter - $ref: ./common.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OSFamilyListResult' default: description: Error schema: $ref: ./common.json#/definitions/CloudError x-ms-examples: List Cloud Service OS Families in a subscription: $ref: ./examples/CloudServiceOSFamilies_List.json x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Cloudserviceosfamilies definitions: InstanceSku: description: The role instance SKU. type: object properties: name: description: The sku name. type: string readOnly: true tier: description: The tier of the cloud service role instance. type: string readOnly: true RoleInstanceNetworkProfile: description: Describes the network profile for the role instance. type: object properties: networkInterfaces: description: >- Specifies the list of resource Ids for the network interfaces associated with the role instance. type: array items: $ref: ./common.json#/definitions/SubResource readOnly: true ResourceInstanceViewStatus: description: Instance view status. type: object properties: code: description: The status code. type: string readOnly: true displayStatus: description: The short localizable label for the status. type: string readOnly: true message: description: The detailed status message, including for alerts and error messages. type: string readOnly: true time: format: date-time description: The time of the status. type: string readOnly: true level: description: The level code. enum: - Info - Warning - Error type: string x-ms-enum: name: StatusLevelTypes modelAsString: false RoleInstanceInstanceView: description: The instance view of the role instance. type: object properties: platformUpdateDomain: format: int32 description: The Update Domain. type: integer readOnly: true platformFaultDomain: format: int32 description: The Fault Domain. type: integer readOnly: true privateId: description: >- Specifies a unique identifier generated internally for the cloud service associated with this role instance.

NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details. type: string readOnly: true statuses: type: array items: $ref: '#/definitions/ResourceInstanceViewStatus' x-ms-identifiers: [] readOnly: true RoleInstanceProperties: description: Role instance properties. type: object properties: networkProfile: $ref: '#/definitions/RoleInstanceNetworkProfile' instanceView: $ref: '#/definitions/RoleInstanceInstanceView' RoleInstance: description: Describes the cloud service role instance. type: object properties: id: description: Resource Id type: string readOnly: true name: description: Resource Name. type: string readOnly: true type: description: Resource Type. type: string readOnly: true location: description: Resource Location. type: string readOnly: true tags: description: Resource tags. type: object additionalProperties: type: string readOnly: true sku: $ref: '#/definitions/InstanceSku' properties: $ref: '#/definitions/RoleInstanceProperties' RoleInstanceListResult: description: The list operation result. type: object properties: value: description: The list of resources. type: array items: $ref: '#/definitions/RoleInstance' nextLink: description: >- The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. type: string required: - value CloudServiceRoleSku: description: Describes the cloud service role sku. type: object properties: name: description: >- The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. type: string tier: description: >- Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** type: string capacity: format: int64 description: Specifies the number of role instances in the cloud service. type: integer CloudServiceRoleProperties: description: The cloud service role properties. type: object properties: uniqueId: description: Specifies the ID which uniquely identifies a cloud service role. type: string readOnly: true CloudServiceRole: description: Describes a role of the cloud service. type: object properties: id: description: Resource id type: string readOnly: true name: description: Resource name type: string readOnly: true type: description: Resource type type: string readOnly: true location: description: Resource location type: string readOnly: true sku: $ref: '#/definitions/CloudServiceRoleSku' properties: $ref: '#/definitions/CloudServiceRoleProperties' CloudServiceRoleListResult: description: The list operation result. type: object properties: value: description: The list of resources. type: array items: $ref: '#/definitions/CloudServiceRole' nextLink: description: >- The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. type: string required: - value CloudServiceUpgradeMode: description: "Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains.\r\nPossible Values are

**Auto**

**Manual**

**Simultaneous**

\r\nIf not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence." enum: - Auto - Manual - Simultaneous type: string x-ms-enum: name: CloudServiceUpgradeMode modelAsString: true CloudServiceRoleProfileProperties: description: Describes the role properties. type: object properties: name: description: Resource name. type: string sku: $ref: '#/definitions/CloudServiceRoleSku' CloudServiceRoleProfile: description: Describes the role profile for the cloud service. type: object properties: roles: description: List of roles for the cloud service. type: array items: $ref: '#/definitions/CloudServiceRoleProfileProperties' x-ms-identifiers: - name CloudServiceVaultCertificate: description: >- Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance. type: object properties: certificateUrl: description: >- This is the URL of a certificate that has been uploaded to Key Vault as a secret. type: string CloudServiceVaultSecretGroup: description: Describes a set of certificates which are all in the same Key Vault. type: object properties: sourceVault: $ref: ./common.json#/definitions/SubResource description: >- The relative URL of the Key Vault containing all of the certificates in VaultCertificates. vaultCertificates: description: >- The list of key vault references in SourceVault which contain certificates. type: array items: $ref: '#/definitions/CloudServiceVaultCertificate' x-ms-identifiers: - certificateUrl CloudServiceOsProfile: description: Describes the OS profile for the cloud service. type: object properties: secrets: description: >- Specifies set of certificates that should be installed onto the role instances. type: array items: $ref: '#/definitions/CloudServiceVaultSecretGroup' x-ms-identifiers: - sourceVault/id LoadBalancerFrontendIPConfigurationProperties: description: Describes a cloud service IP Configuration type: object properties: publicIPAddress: $ref: ./common.json#/definitions/SubResource description: The reference to the public ip address resource. subnet: $ref: ./common.json#/definitions/SubResource description: The reference to the virtual network subnet resource. privateIPAddress: description: The virtual network private IP address of the IP configuration. type: string LoadBalancerFrontendIPConfiguration: description: >- Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. type: object properties: name: description: >- The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. type: string properties: $ref: '#/definitions/LoadBalancerFrontendIPConfigurationProperties' description: Properties of load balancer frontend ip configuration. required: - name - properties LoadBalancerConfigurationProperties: description: Describes the properties of the load balancer configuration. type: object properties: frontendIPConfigurations: description: >- Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. type: array items: $ref: '#/definitions/LoadBalancerFrontendIPConfiguration' x-ms-identifiers: - name required: - frontendIPConfigurations LoadBalancerConfiguration: description: Describes the load balancer configuration. type: object properties: id: description: Resource Id type: string name: description: The name of the Load balancer type: string properties: $ref: '#/definitions/LoadBalancerConfigurationProperties' description: Properties of the load balancer configuration. required: - name - properties CloudServiceSlotType: description: "Slot type for the cloud service.\r\nPossible values are

**Production**

**Staging**

\r\nIf not specified, the default value is Production." enum: - Production - Staging type: string x-ms-enum: name: CloudServiceSlotType modelAsString: true CloudServiceNetworkProfile: description: Network Profile for the cloud service. type: object properties: loadBalancerConfigurations: description: >- List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. type: array items: $ref: '#/definitions/LoadBalancerConfiguration' slotType: $ref: '#/definitions/CloudServiceSlotType' swappableCloudService: $ref: ./common.json#/definitions/SubResource description: >- The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. CloudServiceVaultAndSecretReference: type: object properties: sourceVault: $ref: ./common.json#/definitions/SubResource description: The ARM Resource ID of the Key Vault secretUrl: type: string description: Secret URL which contains the protected settings of the extension description: >- Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. CloudServiceExtensionProperties: description: Extension Properties. type: object properties: publisher: description: The name of the extension handler publisher. type: string type: description: Specifies the type of the extension. type: string typeHandlerVersion: description: >- Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. type: string autoUpgradeMinorVersion: description: >- Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. type: boolean settings: description: >- Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. type: object protectedSettings: description: >- Protected settings for the extension which are encrypted before sent to the role instance. type: object protectedSettingsFromKeyVault: $ref: '#/definitions/CloudServiceVaultAndSecretReference' forceUpdateTag: description: "Tag to force apply the provided public and protected settings.\r\nChanging the tag value allows for re-running the extension without changing any of the public or protected settings.\r\nIf forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.\r\nIf neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and\r\nit is up to handler implementation whether to re-run it or not" type: string provisioningState: description: The provisioning state, which only appears in the response. type: string readOnly: true rolesAppliedTo: description: >- Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. type: array items: type: string Extension: description: Describes a cloud service Extension. type: object properties: name: description: The name of the extension. type: string properties: $ref: '#/definitions/CloudServiceExtensionProperties' CloudServiceExtensionProfile: description: Describes a cloud service extension profile. type: object properties: extensions: description: List of extensions for the cloud service. type: array items: $ref: '#/definitions/Extension' x-ms-identifiers: - name CloudServiceProperties: description: Cloud service properties type: object properties: packageUrl: description: "Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\r\nThis is a write-only property and is not returned in GET calls." type: string configuration: description: >- Specifies the XML service configuration (.cscfg) for the cloud service. type: string configurationUrl: description: "Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\r\nThis is a write-only property and is not returned in GET calls." type: string startCloudService: description: "(Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.\r\nIf false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff." type: boolean allowModelOverride: description: "(Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.\r\nThe default value is `false`." type: boolean upgradeMode: $ref: '#/definitions/CloudServiceUpgradeMode' roleProfile: $ref: '#/definitions/CloudServiceRoleProfile' osProfile: $ref: '#/definitions/CloudServiceOsProfile' networkProfile: $ref: '#/definitions/CloudServiceNetworkProfile' extensionProfile: $ref: '#/definitions/CloudServiceExtensionProfile' provisioningState: description: The provisioning state, which only appears in the response. type: string readOnly: true uniqueId: description: The unique identifier for the cloud service. type: string readOnly: true CloudService: description: Describes the cloud service. type: object properties: id: description: Resource Id. type: string readOnly: true name: description: Resource name. type: string readOnly: true type: description: Resource type. type: string readOnly: true location: description: Resource location. type: string tags: description: Resource tags. type: object additionalProperties: type: string properties: $ref: '#/definitions/CloudServiceProperties' systemData: $ref: ./common.json#/definitions/SystemData x-ms-azure-resource: true required: - location CloudServiceUpdate: type: object properties: tags: description: Resource tags type: object additionalProperties: type: string StatusCodeCount: description: The status code and count of the cloud service instance view statuses type: object properties: code: description: The instance view status code type: string readOnly: true count: format: int32 description: Number of instances having this status code type: integer readOnly: true InstanceViewStatusesSummary: description: Instance view statuses. type: object properties: statusesSummary: description: The summary. type: array items: $ref: '#/definitions/StatusCodeCount' x-ms-identifiers: [] readOnly: true CloudServiceInstanceView: description: InstanceView of CloudService as a whole type: object properties: roleInstance: $ref: '#/definitions/InstanceViewStatusesSummary' sdkVersion: description: >- The version of the SDK that was used to generate the package for the cloud service. type: string readOnly: true privateIds: description: >- 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. type: array items: type: string readOnly: true statuses: type: array items: $ref: '#/definitions/ResourceInstanceViewStatus' x-ms-identifiers: [] readOnly: true CloudServiceListResult: description: The list operation result. type: object properties: value: description: The list of resources. type: array items: $ref: '#/definitions/CloudService' nextLink: description: >- The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. type: string required: - value RoleInstances: description: Specifies a list of role instances from the cloud service. type: object properties: roleInstances: description: >- List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. type: array items: type: string required: - roleInstances UpdateDomain: description: Defines an update domain for the cloud service. type: object properties: id: description: Resource Id type: string readOnly: true name: description: Resource Name type: string readOnly: true UpdateDomainListResult: description: The list operation result. type: object properties: value: description: The list of resources. type: array items: $ref: '#/definitions/UpdateDomain' nextLink: description: >- The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. type: string required: - value OSVersionProperties: description: OS version properties. type: object properties: family: description: The family of this OS version. type: string readOnly: true familyLabel: description: The family label of this OS version. type: string readOnly: true version: description: The OS version. type: string readOnly: true label: description: The OS version label. type: string readOnly: true isDefault: description: Specifies whether this is the default OS version for its family. type: boolean readOnly: true isActive: description: Specifies whether this OS version is active. type: boolean readOnly: true OSVersion: description: Describes a cloud service OS version. type: object properties: id: description: Resource Id. type: string readOnly: true name: description: Resource name. type: string readOnly: true type: description: Resource type. type: string readOnly: true location: description: Resource location. type: string readOnly: true properties: $ref: '#/definitions/OSVersionProperties' OSVersionListResult: description: The list operation result. type: object properties: value: description: The list of resources. type: array items: $ref: '#/definitions/OSVersion' nextLink: description: >- The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. type: string required: - value OSVersionPropertiesBase: description: Configuration view of an OS version. type: object properties: version: description: The OS version. type: string readOnly: true label: description: The OS version label. type: string readOnly: true isDefault: description: Specifies whether this is the default OS version for its family. type: boolean readOnly: true isActive: description: Specifies whether this OS version is active. type: boolean readOnly: true OSFamilyProperties: description: OS family properties. type: object properties: name: description: The OS family name. type: string readOnly: true label: description: The OS family label. type: string readOnly: true versions: description: List of OS versions belonging to this family. type: array items: $ref: '#/definitions/OSVersionPropertiesBase' x-ms-identifiers: - version readOnly: true OSFamily: description: Describes a cloud service OS family. type: object properties: id: description: Resource Id. type: string readOnly: true name: description: Resource name. type: string readOnly: true type: description: Resource type. type: string readOnly: true location: description: Resource location. type: string readOnly: true properties: $ref: '#/definitions/OSFamilyProperties' OSFamilyListResult: description: The list operation result. type: object properties: value: description: The list of resources. type: array items: $ref: '#/definitions/OSFamily' nextLink: description: >- The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. type: string required: - value tags: - name: CloudServiceOperatingSystems - name: CloudServiceRoleInstances - name: CloudServiceRoles - name: CloudServices - name: CloudServicesUpdateDomain