Microsoft.Compute (stable:2024-11-04)

2024/12/20 • 30 new methods

CloudServiceRoleInstances_Delete (new)
Description :  Deletes a role instance from a cloud service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
CloudServiceRoleInstances_Get (new)
Description :  Gets a role instance from a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply to the operation. 'UserData' is not supported for cloud services. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource Name. ,
Required: False ,
}
string ,
type:
{
Description: Resource Type. ,
Required: False ,
}
string ,
location:
{
Description: Resource Location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The role instance SKU. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the cloud service role instance. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Role instance properties. ,
Required: False ,
}
{
networkProfile:
{
Description: Describes the network profile for the role instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the role instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
instanceView:
{
Description: The instance view of the role instance. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Required: False ,
}
string ,
statuses:
{
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
CloudServiceRoleInstances_GetInstanceView (new)
Description :  Retrieves information about the run-time state of a role instance in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/instanceView
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
platformUpdateDomain:
{
Description: The Update Domain. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Required: False ,
}
string ,
statuses:
{
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
CloudServiceRoleInstances_List (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply to the operation. 'UserData' is not supported for cloud services. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource Name. ,
Required: False ,
}
string ,
type:
{
Description: Resource Type. ,
Required: False ,
}
string ,
location:
{
Description: Resource Location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The role instance SKU. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the cloud service role instance. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Role instance properties. ,
Required: False ,
}
{
networkProfile:
{
Description: Describes the network profile for the role instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the role instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
instanceView:
{
Description: The instance view of the role instance. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Required: False ,
}
string ,
statuses:
{
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
}
CloudServiceRoleInstances_Restart (new)
Description :  The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/restart
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServiceRoleInstances_Reimage (new)
Description :  The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/reimage
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServiceRoleInstances_Rebuild (new)
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/rebuild
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServiceRoleInstances_GetRemoteDesktopFile (new)
Description :  Gets a remote desktop file for a role instance in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/remoteDesktopFile
{
roleInstanceName:
{
Description: Name of the role instance. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
file ,
}
CloudServiceRoles_Get (new)
Description :  Gets a role from a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roles/{roleName}
{
roleName:
{
Description: Name of the role. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: The cloud service role properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Specifies the ID which uniquely identifies a cloud service role. ,
Required: False ,
}
string ,
}
,
}
CloudServiceRoles_List (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roles
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: The cloud service role properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Specifies the ID which uniquely identifies a cloud service role. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
}
CloudServices_CreateOrUpdate (new)
Description :  Create or update a cloud service. Please note some properties can be set only during cloud service creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cloud service object. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
CloudServices_Update (new)
Description :  Update a cloud service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cloud service object. ,
Required: False ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
CloudServices_Delete (new)
Description :  Deletes a cloud service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
CloudServices_Get (new)
Description :  Display information about a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
CloudServices_GetInstanceView (new)
Description :  Gets the status of a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/instanceView
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
roleInstance:
{
Description: Instance view statuses. ,
Required: False ,
}
{
statusesSummary:
{
Description: The summary. ,
Required: False ,
}
[
{
code:
{
Description: The instance view status code ,
Required: False ,
}
string ,
count:
{
Description: Number of instances having this status code ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sdkVersion:
{
Description: The version of the SDK that was used to generate the package for the cloud service. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
statuses:
{
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
CloudServices_ListAll (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/cloudServices
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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. ,
Required: False ,
}
string ,
}
CloudServices_List (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If 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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
boolean ,
upgradeMode:
{
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. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If 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: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
swappableCloudService:
{
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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. ,
Required: False ,
}
string ,
}
CloudServices_Start (new)
Description :  Starts the cloud service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/start
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServices_PowerOff (new)
Description :  Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/poweroff
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServices_Restart (new)
Description :  Restarts one or more role instances in a cloud service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/restart
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: List of cloud service role instance names. ,
Required: False ,
}
{
roleInstances:
{
Description: List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServices_Reimage (new)
Description :  Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/reimage
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: List of cloud service role instance names. ,
Required: False ,
}
{
roleInstances:
{
Description: List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServices_Rebuild (new)
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/rebuild
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: List of cloud service role instance names. ,
Required: False ,
}
{
roleInstances:
{
Description: List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServices_DeleteInstances (new)
Description :  Deletes role instances in a cloud service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/delete
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: List of cloud service role instance names. ,
Required: False ,
}
{
roleInstances:
{
Description: List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServicesUpdateDomain_WalkUpdateDomain (new)
Description :  Updates the role instances in the specified update domain.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/updateDomains/{updateDomain}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The update domain object. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource Name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
CloudServicesUpdateDomain_GetUpdateDomain (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/updateDomains/{updateDomain}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource Name ,
Required: False ,
}
string ,
}
CloudServicesUpdateDomain_ListUpdateDomains (new)
Description :  Gets a list of all update domains in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/updateDomains
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource Name ,
Required: False ,
}
string ,
}
,
]
,
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. ,
Required: False ,
}
string ,
}
CloudServiceOperatingSystems_GetOSVersion (new)
Description :  Gets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsVersions/{osVersionName}
{
location:
{
Description: Name of the location that the OS version pertains to. ,
Required: True ,
}
string ,
osVersionName:
{
Description: Name of the OS version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: OS version properties. ,
Required: False ,
}
{
family:
{
Description: The family of this OS version. ,
Required: False ,
}
string ,
familyLabel:
{
Description: The family label of this OS version. ,
Required: False ,
}
string ,
version:
{
Description: The OS version. ,
Required: False ,
}
string ,
label:
{
Description: The OS version label. ,
Required: False ,
}
string ,
isDefault:
{
Description: Specifies whether this is the default OS version for its family. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Specifies whether this OS version is active. ,
Required: False ,
}
boolean ,
}
,
}
CloudServiceOperatingSystems_ListOSVersions (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsVersions
{
location:
{
Description: Name of the location that the OS versions pertain to. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: OS version properties. ,
Required: False ,
}
{
family:
{
Description: The family of this OS version. ,
Required: False ,
}
string ,
familyLabel:
{
Description: The family label of this OS version. ,
Required: False ,
}
string ,
version:
{
Description: The OS version. ,
Required: False ,
}
string ,
label:
{
Description: The OS version label. ,
Required: False ,
}
string ,
isDefault:
{
Description: Specifies whether this is the default OS version for its family. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Specifies whether this OS version is active. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
}
CloudServiceOperatingSystems_GetOSFamily (new)
Description :  Gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsFamilies/{osFamilyName}
{
location:
{
Description: Name of the location that the OS family pertains to. ,
Required: True ,
}
string ,
osFamilyName:
{
Description: Name of the OS family. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: OS family properties. ,
Required: False ,
}
{
name:
{
Description: The OS family name. ,
Required: False ,
}
string ,
label:
{
Description: The OS family label. ,
Required: False ,
}
string ,
versions:
{
Description: List of OS versions belonging to this family. ,
Required: False ,
}
[
{
version:
{
Description: The OS version. ,
Required: False ,
}
string ,
label:
{
Description: The OS version label. ,
Required: False ,
}
string ,
isDefault:
{
Description: Specifies whether this is the default OS version for its family. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Specifies whether this OS version is active. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
CloudServiceOperatingSystems_ListOSFamilies (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/cloudServiceOsFamilies
{
location:
{
Description: Name of the location that the OS families pertain to. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: OS family properties. ,
Required: False ,
}
{
name:
{
Description: The OS family name. ,
Required: False ,
}
string ,
label:
{
Description: The OS family label. ,
Required: False ,
}
string ,
versions:
{
Description: List of OS versions belonging to this family. ,
Required: False ,
}
[
{
version:
{
Description: The OS version. ,
Required: False ,
}
string ,
label:
{
Description: The OS version label. ,
Required: False ,
}
string ,
isDefault:
{
Description: Specifies whether this is the default OS version for its family. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Specifies whether this OS version is active. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
}